產(chǎn)品需要知道的API接口知識

一、什么是接口

API接口:一些預(yù)先定義的函數(shù),目的是提供應(yīng)用程序與開發(fā)人員基于某軟件或硬件得以訪問一組例程的能力,而又無需訪問源碼,或理解內(nèi)部工作機制的細(xì)節(jié)。

系統(tǒng)對外發(fā)布的API地址:包含了IP、端口、API名稱等信息。

數(shù)據(jù)傳輸規(guī)范:SKU只支持9位長度的字符串?dāng)?shù)據(jù),庫存只支持16位長度的數(shù)字,如果傳參格式不對,那么就會啟動反饋機制。

反饋機制:接口中的返回參數(shù),為了保證對方能夠正常獲取所有的數(shù)據(jù),不至于因為數(shù)據(jù)異常之類的原因?qū)е聰?shù)據(jù)丟失,在發(fā)現(xiàn)異常的時候,需要告知對方發(fā)生了什么異常,為什么無法獲取到這個數(shù)據(jù),對方就會根據(jù)這個反饋做出相應(yīng)的調(diào)整,或者重新發(fā)起請求、或者放棄這種數(shù)據(jù)。

聯(lián)調(diào):兩個開發(fā)者之間對著接口是否調(diào)用成功,數(shù)據(jù)能否正常獲取。

二、接口類型有多少種

1. 根據(jù)響應(yīng)的機制可以分為同步、異步接口:

同步接口:A系統(tǒng)請求B接口之后,不需要等待源系統(tǒng)返回結(jié)果就可以進行下一步操作。

異步接口:A系統(tǒng)請求B接口之后,需要等待源系統(tǒng)返回結(jié)果就可以進行下一步操作。

2. 根據(jù)接口的觸發(fā)形式可以分為分發(fā)、訂閱接口

分發(fā)接口:A系統(tǒng)產(chǎn)生新數(shù)據(jù)的時候就分發(fā)給B系統(tǒng)(也可以是多個)。

例如:電商網(wǎng)站后臺的客戶管理系統(tǒng),在產(chǎn)生了一個新的黑名單客戶的時候,就會將數(shù)據(jù)分發(fā)到訂單、推薦等等各個系統(tǒng),以便及時攔截這部分客戶的訂單。

訂閱接口:B系統(tǒng)在需要的時候調(diào)用A系統(tǒng)的接口進行數(shù)據(jù)訂閱。

三、一般接口包含以下幾個內(nèi)容:

接口地址

請求方法

請求參數(shù)

返回內(nèi)容

錯誤代碼

1)接口地址

顧名思義就是接口的地址,以網(wǎng)址的形式展現(xiàn),你通過發(fā)送請求給這個網(wǎng)址來對接口進行交互操作。

2)請求方法

http傳輸形式最基本的方法有4種,分別是GET,POST,PUT,DELETE。我們可以這樣認(rèn)為:一個URL地址,它用于描述一個網(wǎng)絡(luò)上的資源,而HTTP中的GET,POST,PUT,DELETE就對應(yīng)著對這個資源的查,改,增,刪4個操作。

而POST多余用對資源進行修改的操作。比如一般的天氣查詢,賬號金額查詢都以GET形式傳輸,比如登陸信息的傳輸就會用到POST。

以?分割URL和傳輸數(shù)據(jù),參數(shù)之間以&相連,如果數(shù)據(jù)是英文字母/數(shù)字,原樣發(fā)送,如果是空格,轉(zhuǎn)換為+,如果是中文/其他字符,則直接把字符串用BASE64加密,

得出如:%E4%BD%A0%E5%A5%BD,其中%XX中的XX為該符號以16進制表示的ASCII。而POST把提交的數(shù)據(jù)則放置在是HTTP包的包體中。

請求參數(shù)

即傳輸參數(shù)的時候要帶的一些參數(shù),一般文檔中會用表格的形式清晰的說明。當(dāng)我向接口發(fā)送攜帶請求參數(shù)的請求時,都要攜帶什么字段,規(guī)則是什么。如下圖:

返回內(nèi)容

返回內(nèi)容一般會以json或是XML的形式返回。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 對于大部分的人來說,成功沒有捷徑,要有恒心,要持之以恒,努力才能有所成效。比如在Linckia海星客里的海星客們都...
    skyjun閱讀 573評論 2 3
  • 2018.9月24日晨間檢視 昨日 事預(yù)則立不預(yù)則廢,時刻準(zhǔn)備著 自律是通往自由的最佳途徑 做事要有頭有尾,考慮善...
    Missma168閱讀 271評論 0 0
  • 日期:201806022第33/100期 班級人數(shù):69人 一,7.00全部完成截圖并接龍,獲得10分 基礎(chǔ)...
    康東01閱讀 97評論 0 0
  • 第三節(jié),形式框架。形式就是外形,就是美術(shù)里面的指的那個形體結(jié)構(gòu),它是區(qū)別于這個材質(zhì)的,就是形式,我們現(xiàn)在不管它的材...
    文字在飛舞閱讀 660評論 0 0

友情鏈接更多精彩內(nèi)容