如何做一個api接口？

程序員是公司里的技術(shù)崗位，是產(chǎn)品經(jīng)理最親密的伙伴。但是程序員可以理解產(chǎn)品經(jīng)理的工作，產(chǎn)品經(jīng)理卻不一定理解程序員的工作，所以經(jīng)常被無良程序員欺騙。從API接口這個維度，分析API的概念以及為什么要了解它，避免PM們在實際工作中對代碼技術(shù)一無所知。

在日常工作中，產(chǎn)品經(jīng)理負(fù)責(zé)推動項目進(jìn)展。當(dāng)他們與程序員對接時，問完成這個功能需要多少天，程序員給出了五天的回答。雖然你的預(yù)期時間只有三天，但是你除了相信他，按照承諾給他五天時間之外，也無能為力，最終導(dǎo)致項目的拖延。

你不知道這個函數(shù)有多少代碼，程序員的工作量有多大。他利用你的無知故意拖延你的項目進(jìn)度，你是最后一個背黑鍋的。

程序員是公司里的終極技術(shù)崗位。他能理解我們的工作，但我們很難理解他們。為了防止PM在實際工作中受到無良程序員的傷害，本文從API接口這個維度分析了API的概念以及為什么要理解它，從而避免PM在實際工作中對代碼技術(shù)的無知。

一、API的概念

API，官方定義為應(yīng)用編程接口。它指的是一些預(yù)定義的接口，用來提供應(yīng)用程序和開發(fā)人員基于某種軟件或硬件可以訪問的一組例程，而不必訪問源代碼或了解內(nèi)部工作機制的細(xì)節(jié)。

二、為什么要理解API文檔？

既然API這么復(fù)雜，不屬于PM的工作范圍，為什么還需要我們費盡心思去理解呢？我們的目的是什么。

1.定義所需的接口服務(wù)。

API有很多種，最基礎(chǔ)的就是產(chǎn)品最需要的，比如短信API、地圖API、語音API等。如果我們的產(chǎn)品涉及到這個功能，就必須了解這個API，這樣才能在需求設(shè)計階段考慮的更全面。

2.掌握項目開發(fā)的工作量，合理安排計劃。

說白了就是防止被程序員騙。當(dāng)你走過去的時候，你發(fā)現(xiàn)程序員正在勤奮地工作。不好意思，人家是外包，就是欺負(fù)你看不懂代碼。你生氣了嗎？但是，如果你知道接口的難度和工作量，并且明確他需要多長時間才能交給你，項目就不會被耽誤，也更有利于項目進(jìn)程的進(jìn)度。

3.聯(lián)合調(diào)試測試，識別項目風(fēng)險點。

一些關(guān)鍵接口，那些數(shù)據(jù)量大，需要大數(shù)據(jù)壓力測量的接口，必須通過連接測試，測量其更大流量，優(yōu)化或設(shè)置限制，防止系統(tǒng)崩潰。

4.促進(jìn)項目對接

如果PM懂一點技術(shù)，就不會開明顯做不到的玩笑，但還是要程序員來做。從這個角度來說，也更有利于團(tuán)隊溝通，更有利于PM和程序員之間的和諧，避免矛盾，不至于打翻友誼之舟。了解API可以讓PM對技術(shù)有更深刻的理解，更好的衡量開發(fā)工作量，制定功能內(nèi)容。

三。舉例說明API的重要性

優(yōu)點:

開發(fā)者A開發(fā)了軟件A，而開發(fā)者B正在開發(fā)軟件B，A想利用B的一些成果或功能來輔助開發(fā)軟件B，但不想完全輸入軟件A。我該怎么辦？于是A把軟件打包成一個函數(shù)，放在B的軟件里。這個函數(shù)就是API。

如果沒有API，B必須經(jīng)歷軟件A的全過程，這需要花費大量的時間和精力，但如果是接口來訪問一些功能，就簡單方便了。想用就用，想拔就拔。

有一杯密封的果汁叫數(shù)據(jù)庫；果汁上面有一根吸管，叫API。想喝杯子里的果汁，因為是密封的，只能靠吸管插入，不然就喝不到果汁了。

在這個故事里，你屬于某個系統(tǒng)。要想獲得果汁，必須通過一根吸管來實現(xiàn)，也就是一個接口，API，而這個API是數(shù)據(jù)庫中唯一的API。這樣，API就是一個提升項目功能和產(chǎn)品價值的輔助工具。

缺點:

由于API依賴于第三方軟件，訪問方在使用其他軟件包的功能的同時，為自己插入了一個監(jiān)視器，存在惠友友資源網(wǎng)數(shù)據(jù)泄露給第三方的危險。所以如果是公司的核心功能，更好使用內(nèi)部API。

四?？偨Y(jié):萬物皆有聯(lián)系。

可能大家看了美國科幻大片，把程序員想象成了高智商的黑客。但現(xiàn)實是，大多數(shù)情況下，他們只負(fù)責(zé)修復(fù)bug，真正的源代碼只是在網(wǎng)上復(fù)制粘貼而已。所以不要被他的外表所迷惑，PM的應(yīng)該知道他的優(yōu)優(yōu)資源網(wǎng)的工作量，只需要在團(tuán)隊中給出明確的指令來管理項目的進(jìn)度，大致了解程序員的工作內(nèi)容，這樣你就可以管理對接了。

最后，我想說，在產(chǎn)品行業(yè)，一切都是相通的，PM不必質(zhì)疑自己的工作，也不必自卑。如果程序員是科學(xué)家，那么PM就是一個有友資源網(wǎng)的哲學(xué)家，只負(fù)責(zé)改造自然環(huán)境和人類社會的差異。其思維邏輯類似，程序員其實就是PM知識的技術(shù)流。

五、API的實際應(yīng)用

請求示例：前往測試

Curl

PHP

PHPsdk

JAVA

C#

Python

import java.io.BufferedReader;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.Reader;

import java.net.URL;

import java.nio.charset.Charset;

import org.json.JSONException;

import org.json.JSONObject;

import java.io.PrintWriter;

import java.net.URLConnection;

public class Example {

private static String readAll(Reader rd) throws IOException {

StringBuilder sb = new StringBuilder();

int cp;

while ((cp = rd.read()) != -1) {

sb.append((char) cp);

}

return sb.toString();

}

public static JSONObject postRequestFromUrl(String url, String body) throws IOException, JSONException {

URL realUrl = new URL(url);

URLConnection conn = realUrl.openConnection();

conn.setDoOutput(true);

conn.setDoInput(true);

PrintWriter out = new PrintWriter(conn.getOutputStream());

out.print(body);

out.flush();

InputStream instream = conn.getInputStream();

try {

BufferedReader rd = new BufferedReader(new InputStreamReader(instream, Charset.forName("UTF-8")));

String jsonText = readAll(rd);

JSONObject json = new JSONObject(jsonText);

return json;

} finally {

instream.close();

}

}

public static JSONObject getRequestFromUrl(String url) throws IOException, JSONException {

URL realUrl = new URL(url);

URLConnection conn = realUrl.openConnection();

InputStream instream = conn.getInputStream();

try {

BufferedReader rd = new BufferedReader(new InputStreamReader(instream, Charset.forName("UTF-8")));

String jsonText = readAll(rd);

JSONObject json = new JSONObject(jsonText);

return json;

} finally {

instream.close();

}

}

public static void main(String[] args) throws IOException, JSONException {

// 請求示例 url 默認(rèn)請求參數(shù)已經(jīng)URL編碼處理

String url = "https://api-gw.onebound.cn/taobao/item_get/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&num_iid=652874751412&is_promotion=1";

JSONObject json = getRequestFromUrl(url);

System.out.println(json.toString());

}

}


審核編輯黃宇