【IT修真院】接口文档规范以及示例

概述 所有项目接口文档，麻烦上心整理，文档不是给自己看的，只有自己才看得懂的文档就不要放上去浪费其他同学的时间了。 所有文档至少包含以下信息： 1.接口功能 2.接口路径 3.接口入参 4.接口出参 5.各字段说明、约定值、是否必填、默认参数 6.复杂数据结构给出出范例 内容比较多，长期保持迭代的项目可将文档按照功能模块拆分 示例： 命名 所有接口均需符合restful命名风格，相关api设计规则

>>阅读原文<<