【IT修真院】接口文檔規範以及示例

概述 所有項目接口文檔，麻煩上心整理，文檔不是給自己看的，只有自己纔看得懂的文檔就不要放上去浪費其他同學的時間了。 所有文檔至少包含以下信息： 1.接口功能 2.接口路徑 3.接口入參 4.接口出參 5.各字段說明、約定值、是否必填、默認參數 6.複雜數據結構給出出範例 內容比較多，長期保持迭代的項目可將文檔按照功能模塊拆分 示例： 命名 所有接口均需符合restful命名風格，相關api設計規則

>>阅读原文<<