模块接口文档Demo

背景：

• 在软件开发世界，在进行接口文档联调的时候，为了使团队成员能快速理解接口功能、准确对接，提升协作效率，保障项目质量，一般会编写接口文档。
• 接口文档内容一般包括：接口名称、功能描述、请求方式、入参出参，相关示例。
• 下面就是一篇接口文档示例，供大家参考。

XX模块接口文档1.0

1. XX功能接口

描述：

​ 管理后台修改密码

请求地址： http://ip:port/user/changePwd

请求方式：POST

接口入参：

参数名	类型	说明	是否必填
id	String	用户ID	是

接口出参：

字段	类型	说明
code	Integer	状态码
message	String	返回信息
data	Object	数据

请求示例：

{
    "id": "696c64bded2c4aae9589b7e0de457c23"
}

响应示例：

{
  "code": 200,
  "msg": "修改成功"
}

整理完毕，完结撒花~🌻

参考地址：

1.通用前后端接口文档，https://blog.csdn.net/qq_33559093/article/details/85712899