很可惜 T 。T 您現(xiàn)在還不是作者身份，不能自主發(fā)稿哦～
如有投稿需求，請把文章發(fā)送到郵箱tougao@appcpx.com，一經(jīng)錄用會(huì)有專人和您聯(lián)系
咨詢?nèi)绾纬蔀榇河鹱髡哒埪?lián)系：鳥哥筆記小羽毛（ngbjxym）
來源|Kevin改變世界的點(diǎn)滴
做產(chǎn)品經(jīng)理會(huì)調(diào)研各式各樣的第三方需求能力。
以滿足產(chǎn)品提供用戶所需要的功能，比如第三方登錄、圖像識(shí)別、風(fēng)控算法，都有專注的服務(wù)廠商。
通過接入第三方能力，企業(yè)無需自己花時(shí)間和精力投入在具有較高技術(shù)壁壘或時(shí)間成本的需求上。就算企業(yè)自己做，也做不好。
所以，產(chǎn)品經(jīng)理學(xué)會(huì)看API接口文檔，是一項(xiàng)產(chǎn)品經(jīng)理的基本功，可以提升產(chǎn)品設(shè)計(jì)質(zhì)量、以及和開發(fā)溝通效率。
那么，一個(gè)合格的接口文檔包含什么內(nèi)容？
有了接口文檔，我們可以知道第三方能力的功能邏輯、功能的邊界、和接入的條件。比如要接口當(dāng)天的天氣接口信息，可以查看下面的接口。
比如萬年歷的接口文檔描述了接口的傳輸數(shù)據(jù)是當(dāng)天詳情。
接口文檔的編寫規(guī)范
各個(gè)公司甚至一家公司的不同項(xiàng)目組，接口文檔都可能不一樣。項(xiàng)目成員的前后端開發(fā)工程師會(huì)去定義接口，并且隨著需求變化，接口文檔也需要不斷維護(hù)。
所以經(jīng)常有不懂接口文檔的產(chǎn)品經(jīng)理如果讓開發(fā)同學(xué)你把后臺(tái)功能給其他部門直接用、或者某某客戶端你把你的app直接給某某部門后臺(tái)用。
這個(gè)時(shí)候，“開發(fā)的拳頭就捏緊了。”
在一家公司不同項(xiàng)目下，接口仍然有規(guī)范不一致的情況，更何況公司之間的數(shù)據(jù)交流。這也是為什么有產(chǎn)品經(jīng)理的公司，都不會(huì)選擇外包。外包開發(fā)意味著后期維護(hù)在接口、規(guī)范上都是不清楚的，難以搞清楚對方的撰寫代碼思路和潛在問題。
接口規(guī)范集中在4點(diǎn)維度上去做規(guī)范
新增post
修改put
刪除（delete）
獲?。╣et）
通過上面4個(gè)定義接口的權(quán)限。
2.URI定義
以/a開頭，如果你的賬戶涉及到需要登錄權(quán)限、比如我們的微信開放平臺(tái)、第三方單點(diǎn)登錄，則需要/u。如果是通過后臺(tái)要查詢數(shù)據(jù)庫列表，則以/search結(jié)尾。如果是查詢前臺(tái)的列表則以/list結(jié)婚
3.請求參數(shù)和返回參數(shù)
兩個(gè)類型參數(shù)都分為5列：字段、說明、類型、備注、是否必填。
字段：類的屬性
說明：中文解釋字段什么意思
類：屬性類型
有string（字符串）、number（整數(shù)）、object（對象）、arrar（數(shù)組）四種類型。
備注：接口的能力或邏輯解釋，或者可以寫一下列子，有的情況有列子會(huì)讓開發(fā)人員看得懂一些。比如json
返回參數(shù)：返回參數(shù)和產(chǎn)品經(jīng)理的異常是非常相關(guān)的。比如
只會(huì)返回接口調(diào)用成功或失敗
返回某些參數(shù)
返回列表
上面3種返回形式都包含內(nèi)容有區(qū)別。
第一種
新增、刪除、修改等，只需要一個(gè)結(jié)果即可。
第二種
結(jié)構(gòu)體有2個(gè)，第一個(gè)是code/mesaeg/dat ，第二個(gè)是data里寫返回的參數(shù)，data是object類型
第三種
過于偏向開發(fā)知識(shí)，就不再敘述。
接口文檔主要有什么
請求后會(huì)有響應(yīng)。在代碼層面會(huì)有如下的顯示規(guī)則
serid Long 用戶ID
usernick String 用戶登錄名
sessionkey String 用戶會(huì)話key
示例
請求
“XXXX”
響應(yīng)
{“usersession11”:
{“userid”:”12512313”,
“usernck”:” name1 “,
”sessionkey”:”2122323232332435353”,
}}
響應(yīng)有結(jié)果，并且顯示調(diào)用成功則表示接口調(diào)通。
開放平臺(tái)文檔字段說明
第一：請求
說明請求地址，告訴如何調(diào)用接口
第二：調(diào)用秘鑰
比如喜馬拉雅要求申請秘鑰，走開放平臺(tái)賬戶協(xié)議進(jìn)行注冊。
第三：API測試
接通后會(huì)顯示什么結(jié)果，如何知道接口是否接通？就需要在接口文檔里面知道成功的參數(shù)
同理可以在微信開放平臺(tái)上可以看到
多個(gè)接口文檔組成的接口目錄讓產(chǎn)品經(jīng)理和開發(fā)者快速查詢功能點(diǎn)，以集成到自己的產(chǎn)品中。所以產(chǎn)品經(jīng)理做第三方能力調(diào)研，最多時(shí)間的就是去看對方的接口文檔。
包括對接口的描述，比如下圖是地理位置獲取。可以看到在該接口下，可以看到地理位置獲取失敗、成果的提示。
▲ 微信公眾平臺(tái)提供位置信息的接口
本文為作者獨(dú)立觀點(diǎn)，不代表鳥哥筆記立場，未經(jīng)允許不得轉(zhuǎn)載。
《鳥哥筆記版權(quán)及免責(zé)申明》 如對文章、圖片、字體等版權(quán)有疑問，請點(diǎn)擊 反饋舉報(bào)
我們致力于提供一個(gè)高質(zhì)量內(nèi)容的交流平臺(tái)。為落實(shí)國家互聯(lián)網(wǎng)信息辦公室“依法管網(wǎng)、依法辦網(wǎng)、依法上網(wǎng)”的要求，為完善跟帖評論自律管理，為了保護(hù)用戶創(chuàng)造的內(nèi)容、維護(hù)開放、真實(shí)、專業(yè)的平臺(tái)氛圍，我們團(tuán)隊(duì)將依據(jù)本公約中的條款對注冊用戶和發(fā)布在本平臺(tái)的內(nèi)容進(jìn)行管理。平臺(tái)鼓勵(lì)用戶創(chuàng)作、發(fā)布優(yōu)質(zhì)內(nèi)容，同時(shí)也將采取必要措施管理違法、侵權(quán)或有其他不良影響的網(wǎng)絡(luò)信息。
一、根據(jù)《網(wǎng)絡(luò)信息內(nèi)容生態(tài)治理規(guī)定》《中華人民共和國未成年人保護(hù)法》等法律法規(guī)，對以下違法、不良信息或存在危害的行為進(jìn)行處理。
1. 違反法律法規(guī)的信息，主要表現(xiàn)為：
1)反對憲法所確定的基本原則；
2)危害國家安全，泄露國家秘密，顛覆國家政權(quán)，破壞國家統(tǒng)一，損害國家榮譽(yù)和利益；
3)侮辱、濫用英烈形象，歪曲、丑化、褻瀆、否定英雄烈士事跡和精神，以侮辱、誹謗或者其他方式侵害英雄烈士的姓名、肖像、名譽(yù)、榮譽(yù)；
4)宣揚(yáng)恐怖主義、極端主義或者煽動(dòng)實(shí)施恐怖活動(dòng)、極端主義活動(dòng)；
5)煽動(dòng)民族仇恨、民族歧視，破壞民族團(tuán)結(jié)；
6)破壞國家宗教政策，宣揚(yáng)邪教和封建迷信；
7)散布謠言，擾亂社會(huì)秩序，破壞社會(huì)穩(wěn)定；
8)宣揚(yáng)淫穢、色情、賭博、暴力、兇殺、恐怖或者教唆犯罪；
9)煽動(dòng)非法集會(huì)、結(jié)社、游行、示威、聚眾擾亂社會(huì)秩序；
10)侮辱或者誹謗他人，侵害他人名譽(yù)、隱私和其他合法權(quán)益；
11)通過網(wǎng)絡(luò)以文字、圖片、音視頻等形式，對未成年人實(shí)施侮辱、誹謗、威脅或者惡意損害未成年人形象進(jìn)行網(wǎng)絡(luò)欺凌的；
12)危害未成年人身心健康的；
13)含有法律、行政法規(guī)禁止的其他內(nèi)容；
2. 不友善：不尊重用戶及其所貢獻(xiàn)內(nèi)容的信息或行為。主要表現(xiàn)為：
1)輕蔑：貶低、輕視他人及其勞動(dòng)成果；
2)誹謗：捏造、散布虛假事實(shí)，損害他人名譽(yù)；
3)嘲諷：以比喻、夸張、侮辱性的手法對他人或其行為進(jìn)行揭露或描述，以此來激怒他人；
4)挑釁：以不友好的方式激怒他人，意圖使對方對自己的言論作出回應(yīng)，蓄意制造事端；
5)羞辱：貶低他人的能力、行為、生理或身份特征，讓對方難堪；
6)謾罵：以不文明的語言對他人進(jìn)行負(fù)面評價(jià)；
7)歧視：煽動(dòng)人群歧視、地域歧視等，針對他人的民族、種族、宗教、性取向、性別、年齡、地域、生理特征等身份或者歸類的攻擊；
8)威脅：許諾以不良的后果來迫使他人服從自己的意志；
3. 發(fā)布垃圾廣告信息：以推廣曝光為目的，發(fā)布影響用戶體驗(yàn)、擾亂本網(wǎng)站秩序的內(nèi)容，或進(jìn)行相關(guān)行為。主要表現(xiàn)為：
1)多次發(fā)布包含售賣產(chǎn)品、提供服務(wù)、宣傳推廣內(nèi)容的垃圾廣告。包括但不限于以下幾種形式：
2)單個(gè)帳號(hào)多次發(fā)布包含垃圾廣告的內(nèi)容；
3)多個(gè)廣告帳號(hào)互相配合發(fā)布、傳播包含垃圾廣告的內(nèi)容；
4)多次發(fā)布包含欺騙性外鏈的內(nèi)容，如未注明的淘寶客鏈接、跳轉(zhuǎn)網(wǎng)站等，誘騙用戶點(diǎn)擊鏈接
5)發(fā)布大量包含推廣鏈接、產(chǎn)品、品牌等內(nèi)容獲取搜索引擎中的不正當(dāng)曝光；
6)購買或出售帳號(hào)之間虛假地互動(dòng)，發(fā)布干擾網(wǎng)站秩序的推廣內(nèi)容及相關(guān)交易。
7)發(fā)布包含欺騙性的惡意營銷內(nèi)容，如通過偽造經(jīng)歷、冒充他人等方式進(jìn)行惡意營銷；
8)使用特殊符號(hào)、圖片等方式規(guī)避垃圾廣告內(nèi)容審核的廣告內(nèi)容。
4. 色情低俗信息，主要表現(xiàn)為：
1)包含自己或他人性經(jīng)驗(yàn)的細(xì)節(jié)描述或露骨的感受描述；
2)涉及色情段子、兩性笑話的低俗內(nèi)容；
3)配圖、頭圖中包含庸俗或挑逗性圖片的內(nèi)容；
4)帶有性暗示、性挑逗等易使人產(chǎn)生性聯(lián)想；
5)展現(xiàn)血腥、驚悚、殘忍等致人身心不適；
6)炒作緋聞、丑聞、劣跡等；
7)宣揚(yáng)低俗、庸俗、媚俗內(nèi)容。
5. 不實(shí)信息，主要表現(xiàn)為：
1)可能存在事實(shí)性錯(cuò)誤或者造謠等內(nèi)容；
2)存在事實(shí)夸大、偽造虛假經(jīng)歷等誤導(dǎo)他人的內(nèi)容；
3)偽造身份、冒充他人，通過頭像、用戶名等個(gè)人信息暗示自己具有特定身份，或與特定機(jī)構(gòu)或個(gè)人存在關(guān)聯(lián)。
6. 傳播封建迷信，主要表現(xiàn)為：
1)找人算命、測字、占卜、解夢、化解厄運(yùn)、使用迷信方式治??；
2)求推薦算命看相大師；
3)針對具體風(fēng)水等問題進(jìn)行求助或咨詢；
4)問自己或他人的八字、六爻、星盤、手相、面相、五行缺失，包括通過占卜方法問婚姻、前程、運(yùn)勢，東西寵物丟了能不能找回、取名改名等；
7. 文章標(biāo)題黨，主要表現(xiàn)為：
1)以各種夸張、獵奇、不合常理的表現(xiàn)手法等行為來誘導(dǎo)用戶；
2)內(nèi)容與標(biāo)題之間存在嚴(yán)重不實(shí)或者原意扭曲；
3)使用夸張標(biāo)題，內(nèi)容與標(biāo)題嚴(yán)重不符的。
8.「飯圈」亂象行為，主要表現(xiàn)為：
1)誘導(dǎo)未成年人應(yīng)援集資、高額消費(fèi)、投票打榜
2)粉絲互撕謾罵、拉踩引戰(zhàn)、造謠攻擊、人肉搜索、侵犯隱私
3)鼓動(dòng)「飯圈」粉絲攀比炫富、奢靡享樂等行為
4)以號(hào)召粉絲、雇用網(wǎng)絡(luò)水軍、「養(yǎng)號(hào)」形式刷量控評等行為
5)通過「蹭熱點(diǎn)」、制造話題等形式干擾輿論，影響傳播秩序
9. 其他危害行為或內(nèi)容，主要表現(xiàn)為：
1)可能引發(fā)未成年人模仿不安全行為和違反社會(huì)公德行為、誘導(dǎo)未成年人不良嗜好影響未成年人身心健康的；
2)不當(dāng)評述自然災(zāi)害、重大事故等災(zāi)難的；
3)美化、粉飾侵略戰(zhàn)爭行為的；
4)法律、行政法規(guī)禁止，或可能對網(wǎng)絡(luò)生態(tài)造成不良影響的其他內(nèi)容。
二、違規(guī)處罰
本網(wǎng)站通過主動(dòng)發(fā)現(xiàn)和接受用戶舉報(bào)兩種方式收集違規(guī)行為信息。所有有意的降低內(nèi)容質(zhì)量、傷害平臺(tái)氛圍及欺凌未成年人或危害未成年人身心健康的行為都是不能容忍的。
當(dāng)一個(gè)用戶發(fā)布違規(guī)內(nèi)容時(shí)，本網(wǎng)站將依據(jù)相關(guān)用戶違規(guī)情節(jié)嚴(yán)重程度，對帳號(hào)進(jìn)行禁言 1 天、7 天、15 天直至永久禁言或封停賬號(hào)的處罰。當(dāng)涉及欺凌未成年人、危害未成年人身心健康、通過作弊手段注冊、使用帳號(hào)，或者濫用多個(gè)帳號(hào)發(fā)布違規(guī)內(nèi)容時(shí)，本網(wǎng)站將加重處罰。
三、申訴
隨著平臺(tái)管理經(jīng)驗(yàn)的不斷豐富，本網(wǎng)站出于維護(hù)本網(wǎng)站氛圍和秩序的目的，將不斷完善本公約。
如果本網(wǎng)站用戶對本網(wǎng)站基于本公約規(guī)定做出的處理有異議，可以通過「建議反饋」功能向本網(wǎng)站進(jìn)行反饋。
(規(guī)則的最終解釋權(quán)歸屬本網(wǎng)站所有)