如何快速方便的生成好看的接口文档

简介: 一键生成文档

一键生成文档

                    <div class="markdown-section">我们在“2分钟玩转APIPOST”一讲中,简单介绍了如何生成并分享接口文档:

点击分享文档



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

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

请求参数的描述填写

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

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

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

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

响应参数的描述填写

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

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

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

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

相关文章
|
6月前
|
前端开发 小程序 Java
uniapp上传图片 前端以及java后端代码实现
uniapp上传图片 前端以及java后端代码实现
238 0
|
6月前
|
JavaScript Java 测试技术
“村游网”系统的微信小程序开发ssm附带文章和源代码设计说明文档ppt
“村游网”系统的微信小程序开发ssm附带文章和源代码设计说明文档ppt
38 0
|
6月前
|
前端开发 小程序 测试技术
前端后端测试接口mork神器,Apifox使用一分钟入门
前端后端测试接口mork神器,Apifox使用一分钟入门
194 0
|
安全 网络协议 Java
如何读懂接口文档,简单易懂
一份设计得当的接口文档会用自己的方式回答上述问题,它通常会包含以下要素: 接口简介(回答接口是干嘛用的?) 定义请求协议(回答接口怎么用?) 请求地址源 请求方式 请求参数 返回参数示例(回答接口后的返回结果是什么?) 状态码
如何读懂接口文档,简单易懂
eggjs 开发完接口后怎么使用 apifox 生成在线文档?
eggjs 开发完接口后怎么使用 apifox 生成在线文档?
171 0
eggjs 开发完接口后怎么使用 apifox 生成在线文档?
|
JSON 前端开发 数据可视化
再见丑陋的 Swagger,这个API神器界面更炫酷,逼格更高,体验更好
代码未动,文档先行 其实大家都知道 API 文档先行的重要性,但是在实践过程中往往会遇到很多困难。 程序员最讨厌的两件事:1. 写文档,2. 别人不写文档。大多数开发人员不愿意写 API 文档的原因是写文档短期收益远低于付出的成本,然而并不是所有人都能够坚持做有长期收益的事情的。 作为一个前后端分离模式开发的团队,我们经常会看到这样的场景:前端开发和后端开发在一起热烈的讨论“你这接口参数怎么又变了?”,“接口怎么又不通了?”,“稍等,我调试下”,“你再试试..."。 那能不能写好 API 文档,大家都按文档来开发?很难,因为写文档、维护文档比较麻烦,而且费时,还会经常出现 API 更新了
|
前端开发 测试技术
接口测试平台代码实现番外:主页终焉-1
好了,不知不觉,该平台已经跨过了130章的教程,主要功能已经实现过半,一些同学也开始实际项目中使用起来,各种提出的改进建议 优化也都接踵而至,其中最多的就是主页,请求改版。
接口测试平台代码实现番外:主页终焉-1
|
前端开发 JavaScript 测试技术
接口测试平台代码实现番外:主页改版-6
本节我们来实现下那三个饼形图的后台逻辑,不过我这里只做其中一个的,其他俩个留着日后再用。 也就是用户的 资源占平台总的比。资源暂时定为项目数比 接口数比 用例数 。 这里大家可以自行设计,本教程只演示如何实现这个流程。
接口测试平台代码实现番外:主页改版-6
|
前端开发 测试技术 Python
接口测试平台代码实现番外:主页改版-4
接口测试平台代码实现番外:主页改版-4
接口测试平台代码实现番外:主页改版-4
|
前端开发 JavaScript 测试技术
接口测试平台代码实现番外:主页改版-3
接口测试平台代码实现番外:主页改版-3
接口测试平台代码实现番外:主页改版-3