快速生成接口文档的神器

水深无声 2022-08-28 03:48 258阅读 0赞

发送 HTTP 请求

API 界面功能布局

![6e6609bfe1e5d1679eee5ec8fe51674e.png][]

API 请求参数

Header 参数：你可以设置或者导入 Header 参数，cookie也在Header进行设置

![119d4e7aa0b198c8f413ca3225e11311.png][]

Query 参数：Query 支持构造URL参数，同时支持 RESTful 的 PATH 参数（如:id）

![b5eb6580af89ae447e3e8d6aee0eb446.png][]

Body 参数

Body 提供三种类型 form-data / x-www-form-urlencoded / raw ，每种类型提供三种不同的UI界面

1）当你需要提交表单时，切换到 x-www-form-urlencoded

![141b137652c7f5d619e42615bc354fe6.png][]

2）当你需要提交有文件的表单时，切换到 form-data

![5fe8c30e7f4a76b17463c9b02cb132a4.png][]

3）当您需要发送JSON对象或者其他对象时，切换到对应的raw类型即可

![53703364c28001c9a8e21f4a3a340ff2.png][]

API 请求响

应点击发送按钮后，如果有数据返回，则会显示返回数据，响应时间，响应码，Cookie等。

![352ae6b0942f585ba1ae3f606483f464.png][]

注意：返回数据默认是Pretty模式，便于查看 JSON XML 格式。您可以通过切换 原生 或 预览 模式 查看其它类型的类型。

## 点击分享文档 ##

![b095d29dc3ed774b94e72e621a2d7ebe.png][]

复制并打开文档地址就可以看到了完整的接口文档。

![4522ccf609ec382fc1e0a7e9605291db.png][]

本节课主要是讲解一些需要注意的事项。

## 请求参数的描述填写 ##

对于header、query以及form-data和urlencode的body参数，我们在如下地方填写参数描述：

![a001f7955dec38c61615e03ea219953c.png][]

如图中所示，对于一个填写过的参数，我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述，不用重复打字。

对于raw类型的body参数，我们可以通过点击“提取字段和描述”来针对参数进行描述的填写：

![d52eca73a348139d4cfbc1499685e1d6.png][]

对于已经填写过的参数，APIPOST会自动匹配描述，不用重复填写。

## **响应参数的描述填写** ##

很多新手困惑为什么APIPOST分享的文档没有成功响应示例和错误响应示例，那是因为APIPOST不会把发送后的实时响应的数据作为响应示例。

您需要手动的将实时响应结果导入或者复制到对应的成功响应示例和错误响应示例。

![0817bc2c1a3a656253c8e1aa46bc4322.png][]

字段描述的填写跟raw类型的body参数，我们可以通过点击“提取字段和描述”来针对参数进行描述的填写。

同样，对于已经填写过的参数，APIPOST会自动匹配描述，不用重复填写。

### 来源：blog.csdn.net/weixin\_44159454/article/details/119613271 ###

--------------------

【END】

如果看到这里，说明你喜欢这篇文章，请转发、点赞。微信搜索「web\_resource」，关注后回复「进群」或者扫描下方二维码即可进入无广告交流群。

↓扫描二维码进群↓

![3ebe33ca5ac9ecd7b9b0fafd9c3c6b40.png][]

[6e6609bfe1e5d1679eee5ec8fe51674e.png]: /images/20220828/6eca1072bf6f4619b0618057bc514e16.png
[119d4e7aa0b198c8f413ca3225e11311.png]: /images/20220828/ce80d5dd602a48c3bcb1595f7c00437d.png
[b5eb6580af89ae447e3e8d6aee0eb446.png]: /images/20220828/a03ecb21daa642f7a289e52467d22c9a.png
[141b137652c7f5d619e42615bc354fe6.png]: /images/20220828/ad2ac9d30d9e438e9dee00951b883ec5.png
[5fe8c30e7f4a76b17463c9b02cb132a4.png]: /images/20220828/c0afa954566348138084da613c7a9dba.png
[53703364c28001c9a8e21f4a3a340ff2.png]: /images/20220828/b7974fe93bf748b58e1fc70961a9536e.png
[352ae6b0942f585ba1ae3f606483f464.png]: /images/20220828/89ac6b02191b4415a38ba08bee49e58a.png
[b095d29dc3ed774b94e72e621a2d7ebe.png]: /images/20220828/d8d63bd0dd0142d7801b374c1230d596.png
[4522ccf609ec382fc1e0a7e9605291db.png]: /images/20220828/0dd20d43e65f4a6fa0baa59009d49690.png
[a001f7955dec38c61615e03ea219953c.png]: /images/20220828/9eef47ea634f4f6db9d24ac1748598d8.png
[d52eca73a348139d4cfbc1499685e1d6.png]: /images/20220828/d46e7a6cc5c94d398328d9b32b7f307b.png
[0817bc2c1a3a656253c8e1aa46bc4322.png]: /images/20220828/514b47013bb7407f8a096c7c3b996ad0.png
[3ebe33ca5ac9ecd7b9b0fafd9c3c6b40.png]: /images/20220828/f7d9d73950bb45d984cee10630c8e2cf.png