博主信息
宣博文
博文
11
粉丝
0
评论
0
访问量
3727
积分:0
P豆:22

接口文档生成工具 一键生成文档 ApiPost

2021年08月19日 10:47:19阅读数:418博客 / 宣博文

一键生成文档

我们在“2分钟玩转APIPOST”一讲中,简单介绍了如何生成并分享接口文档:

点击分享文档



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

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

请求参数的描述填写

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

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

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

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

响应参数的描述填写

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

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

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

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

版权申明:本博文版权归博主所有,转载请注明地址!如有侵权、违法,请联系admin@php.cn举报处理!

全部评论

文明上网理性发言,请遵守新闻评论服务协议

条评论
  • 下面由composer教程栏目给大家介绍关于composer自动,希望对需要的朋友有所帮助!1.先下载Composer-Setup.exe,下载地址:下载Composer 。
    下面由thinkphp框架教程栏目给大家介绍基于 ThinkPHP6 的注解路由 + 自动 + 自动Mock测试数据,希望对需要的朋友有所帮助!
    jdkjavadoc的作用是“Java”;javadoc是Java器,它从程序源代码中抽取类、方法、员等注释形个和源代码配套的API帮助
    word转换二维码的方法:1、打开浏览器,搜索二维码器,进入网站;2、在导航栏中选择“件”选项卡;3、点击“上传”,选择电脑里的本地word;4、上传好件后,点击活码即可。
    MyBatis逆向程介绍在开发过程中,经常有需要使用MyBatis的情形,通常情况下,MyBatis构建项目避免不了写实体类、Dao、Mapper映射件,这些作都类似,定的重复性,有的时候也容易出错
    下面由sublime教程栏目给大家介绍Sublime Text 3快速HTML5的头部信息和常用的快捷,希望对需要的朋友有所帮助!