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