作者：陈剑冬 历史版本：1 最后编辑：陈剑冬 更新时间：2024-10-16 14:26
概述
接口文档也称为API⽂档，主要⽤来描述系统所提供的接口信息，也是用户调用接口的依据。
系统中导出接口文档的方法有两种：
文档组成
下载好的新增类型的接口文档为HTML格式，打开后查看样式：
基本信息
- 路径：该接口的相对路径，可直接调用。
- 请求协议：客户机与服务器的通信协议。
- 请求方式：GET或POST
- 接口描述：对该接口作简要描述。
请求参数
请求参数包括请求头和请求体。
返回数据
返回数据包括参数名称、类型、示例和备注。
