前端接口文档类型，不同请求类型的接口如何传参

最新推荐文章于 2024-05-20 15:53:54 发布

Like-Yuan

最新推荐文章于 2024-05-20 15:53:54 发布

阅读量1.4k

点赞数 2

文章标签：前端 node.js json ajax

本文链接：https://blog.csdn.net/Yuansjjd/article/details/131294291

版权

1、接口管理工具（接口类型）

1、Postman：Postman 是一个流行的 API 测试工具，在提供接口测试功能的同时，还提供了接口设计、调试、监控、协作等功能。

2、Swagger：Swagger 是一个开源的规范和工具集，可以用于 RESTful API 的设计、文档生成和测试。Swagger 提供了可视化的文档界面，让接口的使用更加方便。

3、Apifox：Apifox 是一种在线 API 接口管理工具，提供了可视化的接口设计、Mock 数据生成、接口测试、文档生成等功能，支持团队协作。

4、YApi：YApi 是一个国内开源的 API 管理平台，除了实现文档管理和 Mock 数据生成外，还提供了持续集成、自动化测试等功能。

5、Apiary：Apiary 可以将 RESTful API 的设计、测试和文档进行集成，并且支持了 Swagger 规范，使用起来比较简单。

6、Excel：Excel 接口文档的优点是方便编写和阅读，易于管理和维护，而且能够直接使用 Excel 中的工具对数据进行统计和分析。

2、接口请求要素

1、请求方法：指请求的类型，例如 GET、POST、PUT、DELETE 等。

2、接口地址：指接口的 URL，表示请求的目标地址。

3、请求参数：根据接口定义不同，可能需要传递不同的参数数据，如查询参数、请求体参数、表单数据等。

4、请求头：如果需要在请求中添加额外的头信息，比如授权信息、Content-Type 等，可以在请求头中添加。

5、身份验证：有些接口要求身份验证，需要在请求中加入访问令牌或其他验证凭证。

6、版本控制：有些接口可能会存在版本管理，需要在请求中明确版本信息。

7、请求格式和编码：请求格式一般有 JSON 和 XML 两种，编码一般使用 UTF-8。

8、请求超时时间：如果需要在规定时间内获取响应结果，则需要设置请求超时时间，超时后将会自动结束请求。

3、请求方法

get请求

GET 请求是一种 HTTP 请求方法，用于从服务器获取数据。在进行 GET 请求时，需要提供以下要素：

请求方法：使用 GET 方法。

接口地址：指定请求的目标接口地址，包括主机名、路径和可选的查询字符串。

请求参数：将参数作为查询字符串的参数添加到 URL 上，多个参数之间用 & 连接，例如：http://api.example.com/user?id=123&name=Tom。或者 export const GetStaff = params=>request.get(“/api/staff”,{params})

请求头：通常不需要添加额外的请求头信息，但可以通过请求头添加 Accept-Encoding 等日期格式等信息。

身份验证：如果需要身份验证，则可以在请求头中添加 Authorization 字段。

缓存控制：可以在请求头中添加 Cache-Control 和 Expires 等字段来进行缓存控制。

GET 请求的优点是请求简单、直观，且可以被缓存，不需要处理请求体等内容，适合于数据量较小或不含机密信息的情况。但是 GET 请求的缺点是传递的参数信息会暴露在 URL 中，不够安全，且请求 URL 有长度限制，无法传递大量的数据。

post请求

POST 请求是一种 HTTP 请求方法，用于向服务器提交数据。在进行 POST 请求时，需要提供以下要素：

请求方法：使用 POST 方法。

接口地址：指定请求的目标接口地址，包括主机名、路径。

请求参数：将参数作为请求体发送，请求体中可以包含多个参数，可以发送 JSON、XML 或表单数据等内容。
如export const Login = data=>request.post(“/api/login”,qs.stringify(data))，
export const Login = data=>request.post(“/api/login”,name= $KaTeX parse error: Expected 'EOF', got '&' at position 12: {data.name}&̲password=$ {data.password})

请求头：通常需要在请求头中添加 Content-Type 字段，指定请求体的格式，如 application/json、application/xml、application/x-www-form-urlencoded 等。

身份验证：如果需要身份验证，则可以在请求头中添加 Authorization 字段。

缓存控制：可以在请求头中添加 Cache-Control 和 Expires 等字段来进行缓存控制。

POST 请求的优点是可以传输大量数据，并且不会将参数信息暴露在 URL 中，更加安全，适合传输敏感信息和大型数据等情况。但是 POST 请求的缺点是不能被缓存，请求体较大时可能会影响性能，同时也需要处理请求体参数和格式等细节。

路径参数

路径参数是一种常见的 RESTful API 设计方式，它通常用于在 URL 中传递变量。路径参数是指在 URL 路径中的一部分，用花括号 {} 包裹起来，表示这部分内容是一个变量，可根据实际情况进行替换。

例如，假设有一个获取用户信息的接口，其 URL 地址为 http://api.example.com/user/{id}，其中 {id} 就是一个路径参数，代表需要获取的用户 ID。当需要获取 ID 为 123 的用户信息时，可以将 URL 替换为 http://api.example.com/user/123，服务器就会根据请求中的路径参数返回对应的用户信息。

路径参数的优点是可以通过 URL 直接传递变量信息，避免了需要在请求体中编码参数的麻烦，同时也方便了 API 的调用和管理。但是路径参数的缺点是 URL 长度会随着传递参数的增加而增加，如果参数过多，则可能会影响 URL 可读性和性能。

请求头header传递参数

HTTP 请求头中包含了很多重要的请求参数，其中一些用于与服务器交换数据、验证权限等功能。下面列举几个常用的请求头参数：

Authorization：用于身份验证的信息，例如 OAuth2 Token、Bearer Token 等。

Content-Type：指定客户端发送的实体数据的格式，例如 application/json、application/x-www-form-urlencoded 等。

Accept：指定客户端能够接收的内容类型，例如 text/html、application/json 等。

User-Agent：指定客户端使用的浏览器或应用程序信息，用于服务器做出适当的响应。

Origin：指定请求的来源，用于跨域请求时进行验证。

Host：指定请求的服务器域名和端口号。

Cookie：指定相应的 Cookie 值，用于在不同页面之间共享状态信息。

请求响应

请求响应是客户端向服务器发送请求后，服务器返回的数据。在 Web 应用程序中，通常使用 HTTP 协议进行请求响应。HTTP 请求响应由两部分组成：请求和响应。

1、请求：客户端向服务器发送请求，请求包括一些必要的信息，例如请求的资源路径、请求方法、请求头等。服务器接收到请求后进行处理并返回响应。

2、响应：服务器根据客户端的请求进行处理，并将相应的结果返回给客户端，响应包括响应状态码和响应体。响应状态码用于表示服务器处理请求的结果，例如 200 表示成功，400 表示请求有误，500 表示服务器内部错误等。响应体则包含了服务器返回的具体数据内容。

在实际应用中，请求响应是 Web 应用程序进行交互的基础，应用程序通过向服务器发送请求获取数据或者执行操作，服务器则响应相应的结果。根据不同的需求，可以使用不同的 HTTP 请求方法及头部信息，来实现对资源的查询、修改、删除等操作。同时，服务器返回的响应可以是不同的数据格式，例如 HTML 页面、JSON 数据、XML 数据等，以满足不同客户端的需求。