关于apipost:快速生成好看实用的接口文档

一键生成文档

关上 apipost 点击分享文档

复制并打开文档地址就能够看到了残缺的接口文档。

本节课次要是解说一些须要留神的事项。

申请参数的形容填写
对于 header、query 以及 form-data 和 urlencode 的 body 参数，咱们在如下中央填写参数形容：

如图中所示，对于一个填写过的参数，咱们能够在新建接口能够通过点击参数形容前面的♦️方块标记疾速导入形容，不必反复打字。

对于 raw 类型的 body 参数，咱们能够通过点击“提取字段和形容”来针对参数进行形容的填写：

对于曾经填写过的参数，APIPOST 会主动匹配形容，不必反复填写。

响应参数的形容填写

很多老手困惑为什么 APIPOST 分享的文档没有胜利响应示例和谬误响应示例，那是因为 APIPOST 不会把发送后的实时响应的数据作为响应示例。

您须要手动的将实时响应后果导入或者复制到对应的胜利响应示例和谬误响应示例。

字段形容的填写跟 raw 类型的 body 参数，咱们能够通过点击“提取字段和形容”来针对参数进行形容的填写。

同样，对于曾经填写过的参数，APIPOST 会主动匹配形容，不必反复填写。