API接口文档介绍

api接口文档

接口文档主要分为三种

第一种为apifox：

Apifox是一款功能齐全、易用性强的API设计和管理工具，可以帮助开发者快速构建和管理API接口，提高开发效率，同时还提供了一些额外的功能，如测试、Mock数据和文档等，帮助开发者更好地进行API开发和管理。

第二种为swigger：

可视化接口设计，自动化测试，接口自动文档，安全认证，团队协作。

第三种为excel表格：

包含基本的请求方式，请求参数，请求示例，响应格式，响应示例，错误码等。

接口文档所必须的要素有：

接口地址，请求方法，请求响应的参数，响应的数据类型

其中请求的参数主要有4种：

1.查询参数

export const GetStaff = params=>request.get("/api/staff",{params})

是一个HTTP请求中的一组键/值对，通常出现在URL的“？”后面，多个键/值对之间使用“&”符号分隔。查询参数的作用是指定HTTP请求的具体内容或参数，服务器收到请求后会根据查询参数进行相应处理或返回结果。

查询参数通常用于以下几个方面：

1. 过滤：可以使用查询参数来过滤请求返回的结果。

2. 分页：当请求结果需要分页时，可以使用查询参数来控制返回结果的起始位置和返回数量。

3. 搜索：可以使用查询参数指定需要搜索的内容。

4. 条件判断：可以使用查询参数指定特定的条件。

2.body参数

export const Login=data=>request.post("/api/loginAdmin",data)

Body参数通常指HTTP请求中的请求体，它是HTTP请求中与URL或查询参数不同的一种传递参数的方式，常用于传递较大或复杂的数据，一般情况下使用HTTP的POST或PUT方法提交请求。

Body参数一般用于下列场景：

1. 传递JSON或XML格式的数据： Body参数可以传输请求体中的JSON或XML格式的数据，通常用于请求数据的更新、创建等操作。

2. 上传文件： Body参数也可以用于上传文件数据，通常使用“multipart/form-data”格式，在Body参数中包含文件的二进制数据，并搭配Boundary分隔符。

3. 传输二进制流数据： Body参数还可以通过二进制流传输数据，例如传输图片、音频、视频等数据。

3.路径参数

export const DelStaff = id=>request.delete("/api/staff/"+id);

路径参数是一种在URL路径中传递参数的方式。路径参数也被称为URL参数或路由参数，它是HTTP请求中的一部分，位于域名和查询参数之间，由冒号“:”后跟参数名表示。

路径参数主要用于以下方面：

1. 定位资源：路径参数可以用于定位资源的具体位置。在RESTful API中，通常使用路径参数指定需要查询、修改、删除的具体资源。

2. 区分路由：路径参数还可以用于区分不同的路由。

3. 传递参数：路径参数也可以用于传递参数，例如传递查询参数中的搜索关键字等信息。

4.header请求头

Header请求头指的是HTTP请求中的头部信息，用于传递额外的请求参数或控制数据传输的行为等。Header请求头包含多个键值对，每个键值对由“：”符号分隔，键和值之间使用空格隔开，多个键值对之间使用换行符“\r\n”隔开。

Header请求头通常用于以下方面：

1. 传递授权信息：可以通过Header请求头传递用户凭证信息。

2. 传递设备信息：可以通过Header请求头传递客户端的设备信息。

3. 传递访问信息：可以通过Header请求头传递请求方的访问信息。

4. 控制请求行为：可以通过Header请求头控制数据传输的行为。