接口設計文檔模板

前言

後端接口設計文檔，個人認爲需要告知接口調用者的內容
博客地址：芒果橙的個人博客 【http://mangocheng.com】

---

接口設計說明-xx系統

修改記錄

本次修改記錄，每次更新後刪除，只顯示當次內容

日期：2020-05-01~2020-05-06

1. 新增權限模塊第3章節內容

接口清單

序號	模塊	說明
1	權限模塊	主要包含用戶的權限功能接口

一、權限模塊

序號	接口	說明
1	searchAuthority	獲取當前登錄用的權限

預定義

• 參數類型未標明，默認皆爲字符串

1. 獲取用戶權限

1）功能說明

獲取當前登錄用的權限，菜單加功能

2）接口說明

• 請求方式：GET
• 請求地址：http://ip:port/authority/searchAuthority
• 請求參數： 無

3）請求參數

• 示例

http://10.254.11.82:7013/authority/searchAuthority

4）響應參數

參數名	類型	說明
data	Map	權限對象
status	String	狀態：1-成功，0-失敗
httpCode	String	Http返回碼
errCode	String	錯誤碼
errMessage	String	錯誤信息

• 示例

{
  "status": 1,
  "data": {
    "MENU": [
      "CLUE",
    ]
  },
  "httpCode": 200,
  "errCode": 0,
  "errMessage": ""
}

2.保存或更新菜單

1）功能說明

菜單管理，新增或更新菜單

2）接口說明

• 請求方式：POST
• 請求地址：http://ip:port/authority/saveOrUpdateMenu
• 請求參數：menuVO

3）請求參數

• MenuVO：菜單對象

參數名	類型	說明
type	String	操作類型（CREATE–新增；UPDATE–更新）
menuPO	TMenuPO	菜單實體類

• 示例1：菜單新增

{
  "menuPO": {
      "id": "",
      "name": "菜單名稱1"
  },
  "type": "CREATE"
}

• 示例2：菜單更新

{
  "menuPO": {
      "id": "23LebronJames",
      "name": "菜單名稱23"
  },
  "type": "UPDATE"
}

4）響應參數

參數名	類型	說明
data	List<String>	保存/更新結果主鍵集合（ryid）
status	String	狀態：1-成功，0-失敗
httpCode	String	Http返回碼
errCode	String	錯誤碼
errMessage	String	錯誤信息

• 示例1：菜單新增

{
  "status": 1,
  "data": [
    "24Kobe"
  ],
  "httpCode": 0,
  "errCode": 0,
  "errMessage": ""
}

• 示例2：菜單更新

{
  "status": 1,
  "data": [
    "23James"
  ],
  "httpCode": 200,
  "errCode": 0,
  "errMessage": ""
}

---

二、xx模塊

該模塊的所有接口及其簡要說明

序號	接口	說明
1	xx	xx

預定義

• 預先定義一些默認的、公共的說明

1. xx接口

1）功能說明

該接口的功能是什麼

2）接口說明

• 請求方式：GET/POST
• 請求地址：接口地址
• 請求參數： 方法參數名稱

3）請求參數

接口的請求參數說明

• 示例

請求參數示例

4）響應參數

接口的響應參數說明

參數名	類型	說明
xx	xx	xx

• 示例

響應參數的示例