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

一剿另、什么是接口

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

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

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

反饋機(jī)制:接口中的返回參數(shù)罪裹,為了保證對方能夠正常獲取所有的數(shù)據(jù),不至于因?yàn)閿?shù)據(jù)異常之類的原因?qū)е聰?shù)據(jù)丟失运挫,在發(fā)現(xiàn)異常的時(shí)候状共,需要告知對方發(fā)生了什么異常,為什么無法獲取到這個(gè)數(shù)據(jù)谁帕,對方就會根據(jù)這個(gè)反饋?zhàn)龀鱿鄳?yīng)的調(diào)整峡继,或者重新發(fā)起請求、或者放棄這種數(shù)據(jù)匈挖。

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

二、接口類型有多少種

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

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

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

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

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

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

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

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

接口地址

請求方法

請求參數(shù)

返回內(nèi)容

錯(cuò)誤代碼

1)接口地址

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

2)請求方法

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

而POST多余用對資源進(jìn)行修改的操作吏奸。比如一般的天氣查詢,賬號金額查詢都以GET形式傳輸陶耍,比如登陸信息的傳輸就會用到POST奋蔚。

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

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

請求參數(shù)

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

返回內(nèi)容

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末求冷,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子窍霞,更是在濱河造成了極大的恐慌匠题,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件但金,死亡現(xiàn)場離奇詭異韭山,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)冷溃,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進(jìn)店門钱磅,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人似枕,你說我怎么就攤上這事盖淡。” “怎么了菠净?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵禁舷,是天一觀的道長。 經(jīng)常有香客問我毅往,道長牵咙,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任攀唯,我火速辦了婚禮洁桌,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘侯嘀。我一直安慰自己另凌,他們只是感情好谱轨,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著吠谢,像睡著了一般土童。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上工坊,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天献汗,我揣著相機(jī)與錄音,去河邊找鬼王污。 笑死罢吃,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的昭齐。 我是一名探鬼主播尿招,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼阱驾!你這毒婦竟也來了就谜?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤啊易,失蹤者是張志新(化名)和其女友劉穎吁伺,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體租谈,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡篮奄,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了割去。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片窟却。...
    茶點(diǎn)故事閱讀 40,040評論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖呻逆,靈堂內(nèi)的尸體忽然破棺而出夸赫,到底是詐尸還是另有隱情,我是刑警寧澤咖城,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布茬腿,位于F島的核電站,受9級特大地震影響宜雀,放射性物質(zhì)發(fā)生泄漏切平。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一辐董、第九天 我趴在偏房一處隱蔽的房頂上張望悴品。 院中可真熱鬧,春花似錦、人聲如沸苔严。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽纯露。三九已至悦污,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間悼沈,已是汗流浹背贱迟。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留絮供,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓茶敏,卻偏偏與公主長得像壤靶,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子惊搏,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評論 2 355

推薦閱讀更多精彩內(nèi)容

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