不懂技術(shù)如何看懂API接口文檔番刊?聰明的你一看就會

api游戲接口到底怎么對接


API是什么菊匿?

api接口英文全稱“ Application Programming Interface ” 通俗點說就是:應(yīng)用程序編程接口。它是操作系統(tǒng)最基本的東西宛篇,通過它可以進(jìn)行計算機硬件操作娃磺。如今各行業(yè)生活中隨處可見,有水電費叫倍、煤氣費偷卧、固話寬帶、交通罰款都能在手機上完成支付吆倦,從而免去一系列繁瑣操作听诸。今年的新冠統(tǒng)計數(shù)據(jù)看新聞的每小時幾乎都會有統(tǒng)計確診數(shù)據(jù)等信息,然而數(shù)據(jù)的背后都是API默默的在運行蚕泽。


api游戲接口到底怎么對接

API就好像是一個傳輸數(shù)據(jù)的通道晌梨,入口需要請求數(shù)據(jù),相當(dāng)于通關(guān)密碼须妻,而出口需要返回結(jié)果仔蝌。接口的使用方不需要關(guān)心接口是如何實現(xiàn)的,只關(guān)心能不能拿到接口最后的返回結(jié)果荒吏。接口的提供方需要定義接口請求參數(shù)敛惊、響應(yīng)內(nèi)容等,還需要關(guān)注接口的性能绰更,是否能滿足高并發(fā)的調(diào)用瞧挤,接口的穩(wěn)定性如何……總之,API就是一個預(yù)先定義的函數(shù)动知。


pi游戲接口到底怎么對接

英文" API developer doc "對于開發(fā)者來說最頭疼的就是除了開發(fā)api接口皿伺,還要規(guī)范的寫好?

API接口一般分為接口描述员辩、接口地址盒粮、請求方法、請求參數(shù)奠滑、相應(yīng)內(nèi)容丹皱、錯誤代碼、實例幾個部分宋税。

1摊崭、接口描述

簡單描述接口的邏輯和作用

2、接口地址

接口的正式url和接口測試的url杰赛,需求方通過調(diào)用接口url呢簸,獲取響應(yīng)內(nèi)容

3、請求方法

一般來說,接口最常見的請求方法為GET和POST兩種方式根时,即讀接口和寫接口瘦赫。通過這兩種方式,實現(xiàn)對數(shù)據(jù)的增刪查改蛤迎。增刪改本質(zhì)都是寫的動作确虱。

4、請求參數(shù)

即需要請求的字段名的名稱和規(guī)則:都是哪些字段替裆,字段的類型是什么校辩,是否必填字段等等

5、響應(yīng)內(nèi)容

接口返回的字段名稱和規(guī)則辆童。

注意:大部分開發(fā)往往不會把所有的字段羅列宜咒,只會列出比較重要的字段。當(dāng)你發(fā)現(xiàn)胸遇,接口文檔中沒有你需求的字段荧呐,別著急找開發(fā),可以看下實例中纸镊,有沒有需求的字段倍阐。

6、錯誤代碼

對接口的錯誤用代碼進(jìn)行歸類逗威,以便能快速找到錯誤原因峰搪,解決問題。

7凯旭、實例

實際調(diào)用時的響應(yīng)的內(nèi)容概耻。

到此無論是api游戲接口還是其他任何接口對接應(yīng)該都會有一定的了解 做產(chǎn)品經(jīng)理是難的,因為要懂得的東西太多了罐呼,而做產(chǎn)品經(jīng)理也是容易的鞠柄,因為有些東西根本不需要精通,只要略懂就可以了嫉柴,基本上你能把以上幾個部分搞明白厌杜,看懂一個API文檔是沒有問題的,和技術(shù)人員對接的時候也不會再被吐槽是個傻逼计螺『痪。總之,產(chǎn)品經(jīng)理做得好就風(fēng)風(fēng)光光登馒,做不好會人人喊打匙握,根本就是條不歸路,而我們已經(jīng)在這條路上越走越遠(yuǎn)……

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末陈轿,一起剝皮案震驚了整個濱河市圈纺,隨后出現(xiàn)的幾起案子秦忿,更是在濱河造成了極大的恐慌,老刑警劉巖蛾娶,帶你破解...
    沈念sama閱讀 221,888評論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件小渊,死亡現(xiàn)場離奇詭異,居然都是意外死亡茫叭,警方通過查閱死者的電腦和手機酬屉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,677評論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來揍愁,“玉大人呐萨,你說我怎么就攤上這事∶Ф冢” “怎么了谬擦?”我有些...
    開封第一講書人閱讀 168,386評論 0 360
  • 文/不壞的土叔 我叫張陵,是天一觀的道長朽缎。 經(jīng)常有香客問我惨远,道長,這世上最難降的妖魔是什么话肖? 我笑而不...
    開封第一講書人閱讀 59,726評論 1 297
  • 正文 為了忘掉前任北秽,我火速辦了婚禮,結(jié)果婚禮上最筒,老公的妹妹穿的比我還像新娘贺氓。我一直安慰自己,他們只是感情好床蜘,可當(dāng)我...
    茶點故事閱讀 68,729評論 6 397
  • 文/花漫 我一把揭開白布辙培。 她就那樣靜靜地躺著,像睡著了一般邢锯。 火紅的嫁衣襯著肌膚如雪扬蕊。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 52,337評論 1 310
  • 那天丹擎,我揣著相機與錄音尾抑,去河邊找鬼。 笑死鸥鹉,一個胖子當(dāng)著我的面吹牛蛮穿,可吹牛的內(nèi)容都是我干的庶骄。 我是一名探鬼主播毁渗,決...
    沈念sama閱讀 40,902評論 3 421
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼单刁!你這毒婦竟也來了灸异?” 一聲冷哼從身側(cè)響起府适,我...
    開封第一講書人閱讀 39,807評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎肺樟,沒想到半個月后檐春,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,349評論 1 318
  • 正文 獨居荒郊野嶺守林人離奇死亡么伯,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,439評論 3 340
  • 正文 我和宋清朗相戀三年疟暖,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片田柔。...
    茶點故事閱讀 40,567評論 1 352
  • 序言:一個原本活蹦亂跳的男人離奇死亡俐巴,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出硬爆,到底是詐尸還是另有隱情欣舵,我是刑警寧澤,帶...
    沈念sama閱讀 36,242評論 5 350
  • 正文 年R本政府宣布缀磕,位于F島的核電站缘圈,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏袜蚕。R本人自食惡果不足惜糟把,卻給世界環(huán)境...
    茶點故事閱讀 41,933評論 3 334
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望牲剃。 院中可真熱鬧糊饱,春花似錦、人聲如沸颠黎。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,420評論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽狭归。三九已至夭坪,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間过椎,已是汗流浹背室梅。 一陣腳步聲響...
    開封第一講書人閱讀 33,531評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留疚宇,地道東北人亡鼠。 一個月前我還...
    沈念sama閱讀 48,995評論 3 377
  • 正文 我出身青樓,卻偏偏與公主長得像敷待,于是被迫代替她去往敵國和親间涵。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,585評論 2 359