技术圈首页
程序员
解决方案
聚合短信
APP下载
登录
注册
首页
文章详情
快速生成接口文档的神器
JAVA葵花宝典
|
205
2021-10-26 10:07
0
0
0
发送 HTTP 请求
API 界面功能布局
API 请求参数
Header 参数:你可以设置或者导入 Header 参数,cookie也在Header进行设置
Query 参数:
Query 支持构造URL参数,同时支持 RESTful 的 PATH 参数(如:id)
Body 参数
Body 提供三种类型 form-data / x-www-form-urlencoded / raw ,每种类型提供三种不同的UI界面
1)当你需要提交表单时,切换到 x-www-form-urlencoded
2)当你需要提交有文件的表单时,切换到 form-data
3)当您需要发送JSON对象或者其他对象时,切换到对应的raw类型即可
API 请求响
应
点击发送按钮后,如果有数据返回,则会显示返回数据,响应时间,响应码,Cookie等。
注意:
返回数据默认是Pretty模式,便于查看 JSON XML 格式。
您可以通过切换 原生 或 预览 模式 查看其它类型的类型。
点击分享文档
复制并打开文档地址就可以看到了完整的接口文档。
本节课主要是讲解一些需要注意的事项。
请求参数的描述填写
对于header、query以及form-data和urlencode的body参数,我们在如下地方填写参数描述:
如图中所示,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述,不用重复打字。
对于raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写:
对于已经填写过的参数,APIPOST会自动匹配描述,不用重复填写。
响应参数的描述填写
很多新手困惑为什么APIPOST分享的文档没有成功响应示例和错误响应示例,那是因为APIPOST不会把发送后的实时响应的数据作为响应示例。
您需要手动的将实时响应结果导入或者复制到对应的成功响应示例和错误响应示例。
字段描述的填写跟raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写。
同样,对于已经填写过的参数,APIPOST会自动匹配描述,不用重复填写。
来源:blog.csdn.net/weixin_44159454/article/details/119613271
0
赞
0
收藏
×
添加附言
附加内容, 使用此功能的话, 会给所有参加过讨论的人发送提醒.
回复数量:
0
暂无评论~~
请注意单词拼写,以及中英文排版,
参考此页
支持 Markdown 格式,
**粗体**
、~~删除线~~、
`单行代码`
, 更多语法请见这里
Markdown 语法
支持表情,见
Emoji cheat sheet
@name 会链接到用户页面,并会通知他
上传图片, 支持拖拽和剪切板黏贴上传, 格式限制 - jp(e)g, png, gif
Ctrl+Enter
下载APP
JAVA葵花宝典
1061
文章
2
获赞
关注TA
NEW
相关文章推荐
取代MybatisPlus?阿里推出了新 ORM 框架!(两者对比参考)
拿transformer做E2E全景分割,这个通用框架霸榜挑战赛,南大、港大联合提出
取代MybatisPlus?阿里推出了新 ORM 框架!(两者对比参考)
[A16Z投资,关注极有可能致富] 稳定币协议 Angle Protocol 测试教程
Dooring可视化之从零实现动态表单设计器
HR-Former | 随迟但到,HRNet+Transformer轻装归来(非常值得学习!!!)
FFmpeg代码架构
处理 Exception 的几种实践,很优雅,已被很多团队采纳!