后台接口文档规范

后台接口文档规范---便于后期查看，记录一下，如有不妥，请联系修改，谢谢

• 后台接口文档规范整理
  • 项目名称一
    • 通用设置
      • 版本号【1.1】
      • 环境域名地址：
        • -Dev：
        • -Test: 
        • -Pre：
        • -Pro：
      • API地址前缀：【如有， 例如：/api/ 】
    • 模块名称一【对照原型一二级菜单目录】
      • 【新增/修改/删除】接口名称1
        • 负责人：
        • 简要描述：（如修改可以说明一下）
        • 请求URL：
        • 请求方式：POST/GET/PUT
        • 请求类型：【application/json】
        • 参数：【参数名称、类型、是否必须、示例、说明】
        • 请求参数示例：{}
        • 返回示例：{code：0, msg: "", data:{}}
        • 返回参数说明：
        • 错误代码说明：【错误代码、说明】
      • 【新增/修改/删除】接口名称2
    • 模块名称二
      • 【新增/修改/删除】接口名称1
      • ...

 

如下图所示：