ApiPost测试接口直接生成API文档

Posted 2022-02-03 jasyca503

由于最近postman 必须登录才可以使用，但是跳转登录页面，却又登录不上，故现在新发现一款 接口开发调试神器ApiPost；可以将其看作是 Swagger 、 Postman 、 Mock 的集合，一个工具就搞定了过去多个软件才能做的事情，避免了我们在多个软件之间来回切换，帮助咱们节省了不少事。

不仅可以一键生成 API 文档，中文，界面简洁美观，而且免费使用！很适合国内的开发者和研发团队及企业。

一、安装 ApiPost

ApiPost 支持 Windows、Mac、Linux 平台，你可以通过这个链接下载软件安装包：

https://www.apipost.cn/download.html?fr=javajsm

安装包下载完成之后，直接点击安装即可！操作起来方便！

并且，ApiPost 针对高校和培训机构还免费，无限工位，不限制功能。

二、ApiPost 介绍

ApiPost 是一个支持模拟 POST、GET、PUT 等常见 HTTP 请求,支持团队协作,并可直接生成并导出接口文档的 API 文档、调试、Mock、测试一体化协作平台。

简单说：ApiPost=Postman + Swagger + Mock

接口开发工作通常需要前端、后端、测试、技术经理等多个岗位协作，但因为流程长所以难管理，不同工具之间数据也缺乏统一规范，导致团队效率往往会很低下！

ApiPost 通过整合工具以及团队协作功能，将 API 研发流程中的每个环节整合打通，大幅度提高整个研发团队的效率，解决了以上问题。

三、ApiPost 亮点

国内外有一些很不错的开源 API 文档产品，比如 Swagger、Rap2 和 Yapi 等，每个产品支持的功能各有不同，可以说各有特点。但因为是开源的，对于企业用户来说会有一些问题，比如国外产品是英文，有的产品的侵入性比较强，学习成本高，支持不及时等。

与这些开源产品相比，ApiPost 的不同之处在于：

1. ApiPost 是国内团队开发，全中文界面，对英文不好的朋友来说，使用起来会舒服！

2. 文档信息丰富学习成本低，功能齐全，用户在社区的提问反馈及时！在现在这样的敏捷开发年代，API 研发越来越注重整个项目的协作，比如 API 调试、API 文档，如果能贯穿整个研发流程，与项目所有角色打通，团队效率和效果都将大大提高！ApiPost 就解决了这个问题。

 

四、ApiPost 实战

4.1、API 调试

调试 API 的过程中有很多重复性的工作占据了大量的时间，比如一些参数（校验登陆的 token）可能每个接口都会用到。没必要每个接口都设置一个这样的参数，最好的方式是放到全局参数里。

ApiPost 的全局参数、全局脚本、cookie 管理、环境切换等功能可以减少大量重复性工作，让 API 调试效率大大提升！

 

 4.2 快速生成接口文档

ApiPost 不仅可以快速生成接口文档，还支持导出离线 html、markdown、word 文档。方便您部署接口文档到本地甚至局域网服务器。

 

 4.3 多人实时协作

传统开发场景是分离的，协作效率很低，而在 ApiPost 前后端开发协作场景中，通过一份接口文档，就可以实现前后端并行开发：后台开发者把 API 托管在 API 网关上，使用 ApiPost 的 mock 功能模拟数据，利用 API 文档功能把 API 信息提供给前端同学，来实现前后端分离。

ApiPost 有更本地化的协作功能，可以团队实时协作，团队成员新建接口同步在所有团队成员项目里。

比如锁定接口，除锁定者和管理员外，其他人均无法对其进行编辑、修改操作。

4.4 参数描述库 

ApiPost 参数描述库功能，解决了大量重复填写参数描述的问题！通常一个接口要调用多次，每次都要手动录入一致的描述，效率太低了！

ApiPost 还可以自定义参数描述库，将项目用到的大量参数进行预注释，下次调用直接点选。如果你没有自定义描述库，第一次输入描述后也会自动加入描述库。

 4.5 自动生成代码

填写完接口请求参数后您就可以生成程序代码：

提供多达 10 多种语言以及各种 SDK 的 HTTP 请求代码，代码可以快速的集成到您的代码中：

 五、后记

最后，强烈建议开发人员，包括后端、前端、测试朋友们都试试 ApiPost，尤其是对后端开发朋友来说，这款工具实在太香了！