快速生成好看实用的接口文档

举报
雨中人 发表于 2021/08/30 11:00:11 2021/08/30
【摘要】 一键生成文档打开apipost点击分享文档复制并打开文档地址就可以看到了完整的接口文档。本节课主要是讲解一些需要注意的事项。请求参数的描述填写对于header、query以及form-data和urlencode的body参数,我们在如下地方填写参数描述:如图中所示,对于一个填写过的参数,我们可以在新建接口可以通过点击参数描述后面的♦️方块标志快速导入描述,不用重复打字。对于raw类型的bo...

一键生成文档

打开apipost点击分享文档

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

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

请求参数的描述填写

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

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

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

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

响应参数的描述填写

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

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

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

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

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。