1、接口请求方式
- 定义接口时优先使用POST请求方式；
- 无参数或者使用URL路径传参的接口可以使用GET请求方式；
2、接口命名规范
- 接口路径由[服务名]+[资源]+[动作]组成；
- 接口路径使用小写字母；
- 单词间使用下划线分割；
3、接口请求头规范
- 请求头需要包含JWT的token；
4、接口请求体规范
- 暂无
5、接口返回体规范
- 返回体由code、data、msg、version四部分组成；
- 成功，code的值是0；
- 失败，code的值是错误码，msg放入失败原因；
- data放入接口返回给前端的数据，data的key统一使用下划命名；
- version放入接口版本信息，字符串类型，默认1.0；
评论已关闭