接口设计文档模板

前言

后端接口设计文档，个人认为需要告知接口调用者的内容
有助于分析开发功能、评估工作量
博客地址：芒果橙的个人博客 【http://mangocheng.com】

接口设计说明-xx系统

修改记录

本次修改记录，每次更新后删除，只显示当次内容

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

1. 新增权限模块第3章节内容

接口清单

一、权限模块

预定义

• 参数类型未标明，默认皆为字符串

1. 获取用户权限

1）功能说明

获取当前登录用的权限，菜单加功能

2）接口说明

• 请求方式：GET
• 请求地址：http://ip:port/authority/searchAuthority
• 请求参数： 无

3）请求参数

• 示例

http://10.254.11.82:7013/authority/searchAuthority

4）响应参数

• 示例

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

2.保存或更新菜单

1）功能说明

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

2）接口说明

• 请求方式：POST
• 请求地址：http://ip:port/authority/saveOrUpdateMenu
• 请求参数：menuVO

3）请求参数

• MenuVO：菜单对象

• 示例1：菜单新增

{ 
   
  "menuPO": { 
   
      "id": "",
      "name": "菜单名称1"
  },
  "type": "CREATE"
}

• 示例2：菜单更新

{ 
   
  "menuPO": { 
   
      "id": "23LebronJames",
      "name": "菜单名称23"
  },
  "type": "UPDATE"
}

4）响应参数

• 示例1：菜单新增

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

• 示例2：菜单更新

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

二、xx模块

该模块的所有接口及其简要说明

预定义

• 预先定义一些默认的、公共的说明

1. xx接口

1）功能说明

该接口的功能是什么

2）接口说明

• 请求方式：GET/POST
• 请求地址：接口地址
• 请求参数： 方法参数名称

3）请求参数

接口的请求参数说明

• 示例

请求参数示例

4）响应参数

接口的响应参数说明

• 示例

响应参数的示例

备注： word文档下载地址 https://download.csdn.net/download/qq_35893033/86806572?spm=1001.2014.3001.5503

今天的文章接口设计文档模板分享到此就结束了，感谢您的阅读，如果确实帮到您，您可以动动手指转发给其他人。