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

一键生成文档

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

点击分享文档

如何快速方便的生成好看的接口文档?_第1张图片

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

如何快速方便的生成好看的接口文档?_第2张图片

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

请求参数的描述填写

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

如何快速方便的生成好看的接口文档?_第3张图片

如图中所示,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述,不用重复打字。对于raw类型的body参数,我们可以通过点击“提取字段和描述”来针对参数进行描述的填写:

如何快速方便的生成好看的接口文档?_第4张图片

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

响应参数的描述填写

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

如何快速方便的生成好看的接口文档?_第5张图片

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

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

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

想了解直接移步官网吧,链接
Apipost-基于协作,不止于API文档、调试、Mock

你可能感兴趣的