写点什么

分享 ApiPost 的个人体验感受

作者:Xd
  • 2022 年 5 月 26 日
  • 本文字数:1760 字

    阅读完需:约 6 分钟

ApiPost 是一个支持团队协作,并可直接生成文档的 API 调试、管理工具。它支持模拟 POST、GET、PUT 等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具 。使用者不仅可以利用 apiopst 调试接口,还可以书写相关注释(接口文档),方便的生成可读性好、界面美观的在线接口文档。

本文主要包含以下内容:

介绍 ApiPost 工具,它能做什么

下载、安装的方法一些常用的操作

介绍一些使用技巧

前言:apipost 能做什么?ApiPost 是一个支持团队协作,并可直接生成文档的 API 调试、管理工具。它可以像 postman 那样支持模拟 POST、GET、PUT 等常见请求也可以快速生成接口文档,是后台接口开发者或前端、接口测试人员不可多得的工具 。首先看下它的界面风格。

下载、安装 apipostApiPost 安装下载十分简单,在官网(自行百度)直接下载对应操作系统的安装包(支持 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 设置为:变量名即可。

这样的话,我们生成的文档就会类似:


心动的小伙伴可以试一下,链接:Apipost-基于协作,不止于API文档、调试、Mock

Apipost 官方链接:

Apipost-基于协作,不止于API文档、调试、Mock​


版权声明:本文为 稀土掘金 博主可可 kkkk 的原创文章。原文链接:https://juejin.cn/post/7066079261882318885

用户头像

Xd

关注

还未添加个人签名 2022.03.28 加入

还未添加个人简介

评论

发布
暂无评论
分享ApiPost的个人体验感受_后端_Xd_InfoQ写作社区