後臺接口文檔規範

後臺接口文檔規範---便於後期查看，記錄一下

• 後臺接口文檔規範整理
  • 項目名稱一
    • 通用設置
      • 版本號【1.1】
      • 環境域名地址：
        • -Dev：
        • -Test: 
        • -Pre：
        • -Pro：
      • API地址前綴：【如有， 例如：/api/ 】
    • 模塊名稱一【對照原型一二級菜單目錄】
      • 【新增/修改/刪除】接口名稱1
        • 負責人：
        • 簡要描述：（如修改可以說明一下）
        • 請求URL：
        • 請求方式：POST/GET/PUT
        • 請求類型：【application/json】
        • 參數：【參數名稱、類型、是否必須、示例、說明】
        • 請求參數示例：{}
        • 返回示例：{code：0, msg: "", data:{}}
        • 返回參數說明：
        • 錯誤代碼說明：【錯誤代碼、說明】
      • 【新增/修改/刪除】接口名稱2
    • 模塊名稱二
      • 【新增/修改/刪除】接口名稱1
      • ...

 

如下圖所示：