# Apifox 规范
- 搜索支持 url, 名称
- 版本是兼容旧版本,不同功能必须使用不同接口 (如单个处理,批量处理,PC 处理,小程序处理)
- 接口的封装尽量在 service 层,controller 不是公共接口,每个页面有一个接口(方便权限管理,统计分析,追踪功能的使用情况)
# 目录
- 最子层目录是页面(如果接口是其它页面共用的接口,也需要写一个接口,指明引用目录, 通过 markdown)
- 通用接口(达人(筛选项 浮动组件),商品(筛选项 浮动组件),用户(授权 | 登录、注册、用户信息 筛选项 | 推品官,招商顾问,全部用户))
- 已废弃待删除(前端已弃用,功能已发布)
# 接口
名称:列表、汇总、详情、新增、修改、删除
状态:
开发中-后端技术开发中
联调中-后端技术开发完,发布到测试
已测完-前端功能对接完
已发布-后端发布到正式
已废弃-前端已弃用(功能上线后移到目录【已废弃待删除】)
责任人:接口负责人
标签:页面名称(多个页面共用时,公共模块)
最少有一个成功的响应示例,不明确的字端需要有备注
评论:排查问题的 sql