API 使用说明
本项目采用 API
先行的模式,开发之前先制定 API
文档,前后端根据同一份 API
进行开发,减少沟通成本,提高开发效率。
API
文档基于 swagger2.0
规范,使用 YAML
编写。
API
文档会跟随设计图同步更新,因为设计图更新是阶段性的,所以 API
也是阶段性更新。
使用方式:
- 打开 https://editor.swagger.io/ ,将文档内容复制进去即可看到效果。
- 使用 easy-mock 新建项目并将
API
文件导入。 - 使用各种编辑器的插件,插件下载及安装请自行查阅。
更改 API 流程
开发过程中如需新增或更改 API,将需求以文档的方式提交给组长,组长确认格式是否符合规范(应包含API路径名,用途,输入参数,期望返回值等)。
组长确认无误后在组长群里联系相关的小组长沟通协商,确定修改后将需要新增或修改的 API 发给 Solo
,统一更新并发布更新通知。
更新日志
v0.0.1
提供首页、注册、登录三个页面 API