ApiPost 是一个反对团队合作,并可间接生成文档的 API 调试、管理工具。它反对模仿 POST、GET、PUT 等常见申请,是后盾接口开发者或前端、接口测试人员不可多得的工具。使用者不仅能够利用 apiopst 调试接口,还能够书写相干正文(接口文档),不便的生成可读性好、界面好看的在线接口文档。
本文次要蕴含以下内容:
介绍 ApiPost 工具,它能做什么
下载、装置的办法
一些罕用的操作
介绍一些应用技巧
前言:apipost 能做什么?
ApiPost 是一个反对团队合作,并可间接生成文档的 API 调试、管理工具。它能够像 postman 那样反对模仿 POST、GET、PUT 等常见申请也能够疾速生成接口文档,是后盾接口开发者或前端、接口测试人员不可多得的工具。首先看下它的界面风格。
下载、装置 apipost
ApiPost 装置下载非常简略,在官网(自行百度)间接下载对应操作系统的安装包(反对 window、mac、linux)装置即可,官网也提供了丰盛的装置文档,这里不再赘述了。
一些罕用的操作
ApiPost 反对常见的接口发送、文档生成等。作为一名开发者,置信你从下面截图就能够根本看进去它的应用办法。这里次要介绍一些其余的常见操作。不过首次应用的时候,须要先注册一个账号,创立一个我的项目,而后点击左侧的 APIS 菜单栏就进到控制台了。
以下图是针对目录的罕用操作
总之应用根本很简略,你下载安装一看就会了,切实有问题能够去官网查看文档或者去社区发问。
一些操作技巧
小技巧之:疾速导入参数
apipost 反对多种格局的参数导入,见下图,你再也不必一个一个参数的缓缓写了:
导入格局反对 key-value 和 json 格局:
1-1:key-value 格局导入示例:
key-value 格局常见的就是浏览器(F12)控制台的数据格式,见下图:
咱们,复制以上申请头参数,而后粘贴到 apipost,点击导入
参数则霎时导入到了申请参数中,见下图:
以上示例只是展现了如何疾速导入到 header 参数,其余参数比方 query、body 操作形式是截然不同滴。
1-2:json 格局导入示例:
apipost 也反对 json 格局的参数导入,参数格局能够如下:
{
"id": 123,
"title": "我是题目"
}
如图,点击导入,参数也疾速导入到了申请参数中。
小技巧之:参数正文自动识别
下面咱们写了如何疾速导入参数,其实对于生成接口文档来说,参数形容(正文)才是最要命的,对于咱们始终繁忙的程序员,花大量工夫用在写文档上切实太累!
好在 apipost 帮咱们节俭了很多工夫,一个参数,只有写过一次正文,下次遇到同样的参数间接选中就行。举例:
在上图中,咱们针对 id 和 title 写了对应的正文:
id:“我是文章 Id”
title:“我是文章题目”
当咱们新建一个接口的时候,如果这个接口同样用到了 id 或者 title 等参数,点击参数形容就会呈现出刚刚输出过的参数形容,间接选中即可,不必再麻烦的打字输出了。
这个小性能是不是节约了开发小伙伴很多工夫呢?
小技巧之:疾速定位以后接口目录
左侧的目录默认都是闭合的,有时候咱们不晓得以后正在编辑的接口属于哪个目录,找起来相当头疼。apipost 提供了“定位到以后接口目录”性能(见下图),能够疾速关上以后正在编辑的接口、文档所在的目录,是不是解决了您的大问题了呢?
其实,apipost 还有很多很多更加符合中国人操作习惯的小性能,期待您去发现。
小技巧之:生成并分享在线接口文档
说了这么多,如同还没说到重点,apipost 怎么生成接口文档呢?很简略:新版 ApiPost 反对分享单个我的项目、也反对分享单个目录或者文档:
反对设置文档链接的有效期:
反对设置文档的查看权限:
小 TIPS:apipost 导出文档响应为空?
很多小伙伴问,为什么 apipost 导出文档响应为空?那是因为你么有增加响应示例。
ApiPost 生成的文档怎么增加响应示例?很简略:
小技巧之:疾速克隆一个我的项目
有时候咱们须要复制一个我的项目的数据,ApiPost 如何克隆(复制)一个我的项目?
很简略:
小技巧之:resful 格调的接口的门路变量
相似这样格调的接口:
example.com/api/users/1 //GET 获取标识为 1 用户信息
ApiPost 反对把像这样的 restful 格调链接中的 uid 也就是 1 作为参数独自提出来比拟不便调试和解释。
只须要把 URL 门路中的 ID 设置为
: 变量名
即可。
这样的话,咱们生成的文档
分享链接:https://console.apipost.cn/re…