推荐一款神级 API 接口管理神器

Posted 2022-01-27 ABin-阿斌

我是 ABin-阿斌：写一生代码，创一世佳话，筑一览芳华。 如果小伙伴们觉得我的文章有点 feel ，那就点个赞再走哦。

文章目录

• 一、前言
• • 二、ApiPost简介
  • 怎么制作简洁精准的API文档？
  • • 要有层次有结构
    • 精准具象
    • 界面友好可搜索
  • 三、ApiPost 是什么
  • 四、ApiPost的亮点
  • • 4.1、与这些开源产品相比，ApiPost的不同之处在于：
    • 4.2、快速API调试
    • 4.3、快速生成接口文档
    • 4.4、多人实时协作
    • 4.5、丰富的细节设计
  • 总结：

一、前言

• 文章原作者：Java后端：微信公众号：Java后端

• API 本质是一个封装了功能并公开一个用于访问功能的接口！关于API 的信息外界无从得知，所以没有好的文档，使用者就无法理解和使用。API 文档最核心的需求是简洁精准，当然要是颜值再高一点那就更好了！

• 精准简洁的 API 文档可以推动研发数据规范化，降低协作成本，从而大幅度提高团队效率！最近总有阿里、腾讯、滴滴的开发朋友提到 ApiPost，自己体验操作后，发现 它 的优势的确明显。

二、ApiPost简介

• ApiPost 官方网站下载地址：https://www.apipost.cn/download.html?fr=jvhd

• 可以一键生成 API 文档，完全中文，界面简洁美观，而且免费使用！很适合国内的开发者使用。听说针对高校和培训机构还是完全免费的，无限工位，不限制任何功能。

怎么制作简洁精准的API文档？

要有层次有结构

• API 文档绝不只是简单直白的列出各种参数，好的文档应该是有层次有结构的内容，可以让使用者清晰理解。

精准具象

• API 本身就是抽象的，如果文档也是抽象的，对于使用者来说就是一场灾难了！可以多用实际案例，案例能显著减少理解成本。

• 其次表达还要尽量精准，避免模糊的表达。

界面友好可搜索

• 一个好的 API 文档，它的界面交互也要简单易用，尽量提供好的使用体验。以往的文档比较简单，现在的文档多是基于网页实现，可设计性很高，可以尝试多种设计方式。

• 文档如果内容过多，在大量的代码函数中寻找目标会是一件非常费时的事。为使用者提供搜索功能，可以减少搜索相关内容的时间。

三、ApiPost 是什么

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

简单说，他的组合就是：

• ApiPost=Postman + Swagger + Mock + JMeter

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

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

四、ApiPost的亮点

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

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

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

• 其次文档信息丰富学习成本低，功能齐全，用户在社区的提问反馈及时！

• 在现在这样的敏捷开发年代，API 研发越来越注重整个项目的协作，比如 API 调试、API 文档，如果能贯穿整个研发流程，与项目所有角色打通，团队效率和效果都将大大提高！ApiPost 就解决了这个问题。

4.2、快速API调试

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

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

4.3、快速生成接口文档

• 国内对接口文档是非常重视的，有文档先行的理念，而国外对接口文档就没那么重视了。ApiPost 的生成文档体验非常好，具体我们可以对比一下两个产品的生成接口文档的过程。

• Postman 的生成接口文档要点击 publish，然后生成设置页面，设置后才生成接口文档。

• ApiPost 不仅可以在接口页面直接生成接口文档链接，还可以显示响应事例，具体页面如图：

4.4、多人实时协作

• 传统开发场景是分离的，协作效率很低，而在 ApiPost 前后端开发协作场景中，通过一份接口文档，**就可以实现前后端并行开发

• 后台开发者把 API 托管在API网关上，使用 ApiPost 的 mock 功能模拟数据，利用 API 文档功能把 API 信息提供给前端同学，来实现前后端分离。

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

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

• 还有很多协作方面的小功能，比如协作日志，归档管理、一键导入参数……

4.5、丰富的细节设计

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

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

• 类似的细节还有很多，这些细节设计据说都是产品在用户的反馈中总结而来，可以说正是这些细节让 apipost 成为最懂用户，最重视用户的产品！

总结：

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

• 除此之外 ApiPost 还有更多更好的功能

• 可以登陆官方网站下载体验： https://www.apipost.cn/download.html?fr=jvhd