Q
程序報告里的接口清單怎么排才方便下游直接對接？
A
按調(diào)用頻次從高到低排，每條接口頂格寫路徑，下面縮進(jìn)兩格寫請求方法、必填參數(shù)、返回成功結(jié)構(gòu)體字段名。失敗返回只寫HTTP狀態(tài)碼+一句話原因，不寫錯誤碼表。字段名用代碼里真實(shí)變量名，不翻譯成中文。參數(shù)類型寫string/int/bool，不寫“字符串類型”。
高分寫作經(jīng)驗
熱門篇幅區(qū)間
推薦寫法
數(shù)據(jù)顯示，有38.8%的用戶認(rèn)為，首選的寫法是字段名嚴(yán)格同步代碼，43.2%%的用戶傾向選擇3500-4500字，而30.4%%的用戶選擇2800-3400字，18.8%%選擇4600-5200字。新手最容易踩的坑是接口按字母順序排，參數(shù)寫“用戶信息對象”，返回示例用虛構(gòu)JSON，字段名和代碼里對不上。
適用對象
聯(lián)調(diào)中的前端、做自動化測試的QA、接API的第三方、寫SDK的同事
新手常犯的誤區(qū)
接口按字母順序排，參數(shù)寫“用戶信息對象”，返回示例用虛構(gòu)JSON，字段名和代碼里對不上。
