资讯专栏INFORMATION COLUMN

api 接口管理工具

marser / 2065人阅读

摘要:接口管理工具大致分为线上工具和自建工具。安装其他工具上面讲的,不管是线上工具还是自建工具,都是接口集成工具,主要是为了提供数据功能。类似网易云笔记印象笔记的笔记管理工具。

api 接口管理工具

现在,Web 应用的前后端分离事实上已经成为了大家都认可的一种开发方式,前后端分离之后,前端与后端都用接口(api)来沟通,这就需要我们做好 API 接口管理,所以,这次来聊聊 API 接口管理工具。

API 接口管理工具大致分为线上工具和自建工具。

1. 线上工具

比较热门的线上工具有:

eolinker

apizza:界面与 postman 比较像

easyapi

apiview

2. 自建工具

企业一般都采用自建工具,自己维护一套 API 接口管理工具,比较热门的有:

yapi:去哪儿出品,线上演示地址 http://yapi.demo.qunar.com

RAP / rap2-delos + rap2-dolores:阿里出品,线上演示地址 http://rap2.taobao.org/

easy-mock:线上演示地址 https://easy-mock.com/

swagger:国外比较热门的接口管理工具

2.1 yapi

环境需求:Node.js (>= v7.6) & MongoDB (>= v2.6) & Git

yapi UI 很漂亮,操作很流畅,安装比较简单,使用也比较简单,不与其他第三方工具或语言绑定。

如果喜欢简单、UI 友好的,推荐使用这个。

安装:yapi#安装

2.2 RAP / rap2-delos + rap2-dolores

环境需求:Node.js (>= v8.9) & MySQL (>= v5.7) & Redis(>= v4.0)

rap 功能非常全,UI 不是很漂亮,安装比较复杂,使用也比较复杂,数据生成使用 mock.js。

如果对功能完善、系统稳定、用 mock.js 生成数据有偏好的,推荐使用这个。

RAP 目前有两个版本,第一个版本的 RAP 已经被官方废弃了,建议用第二个版本。

RAP2 分成了两个包:

rap2-delos:后端数据 API 服务器

rap2-dolores:前端静态资源

RAP2 的安装步骤要麻烦一些,rap2-delos 可以参考官方文档 rap2-delos#部署、非官方rap2-delos部署文档,rap2-dolores 可以参考官方文档 rap2-dolores#deployment-部署。

2.3 easy-mock

环境需求:Node.js (>= v8.9) & MongoDB (>= v3.4) & Redis(>= v4.0)

easy-mock UI 很漂亮,操作很流畅,安装比较简单,使用也比较简单,数据生成使用 mock.js,并且支持导入 Swagger Docs API。

如果喜欢简单、UI 友好的,并且喜欢用 mock.js 生成数据或者导入 Swagger Docs API 的,推荐使用这个。

安装:easy-mock#quick-start

2.4 swagger

Swagger 其实并不是一个工具,而是一系列工具,或者说叫一个生态:

OpenAPI-Specification:基于 yaml 语法格式定义的一套开放 API 文档规范

swagger-ui:UI 展示库

swagger-codegen:根据 Swagger 定义的 RESTful API 自动生成 Swagger 文档(for java)

swagger-core:java 核心库

swagger-editor:可视化编辑器

ReDoc:生成格式优美的 UI 界面(第三方)

swagger-node:for node.js

go-swagger:for Go

如你所见,这个生态功能非常全,但使用非常复杂,入门坎比较高。

这套工具对后端非常有用,特别是 java 开发,能直接根据注释自动生成相应的 API 规范文档,然后直接根据这个 API 规范文档自动生成 UI 可视化界面与数据 Mock 服务器,而不是我们手动创建。

安装:swagger

3. 其他工具

上面讲的,不管是线上工具还是自建工具,都是接口集成工具,主要是为了提供数据 Mock 功能。

如果仅仅是为了以静态文本的形式做展示用,可以试试下面的一些工具:

3.1 Git 仓库 + Markdown

把接口文档多带带建一个项目,使用 Markdown 的格式来书写。

了解 Markdown 语法。

3.2 leanote

类似网易云笔记、印象笔记的笔记管理工具。

了解 leanote。

3.3 gollum

基于 Git 的 wiki 系统。

了解 gollum。

3.4 wiki.js

基于 Node.js 的 wiki 系统。

了解 wiki.js。

后续

更多博客,查看 https://github.com/senntyou/blogs

作者:深予之 (@senntyou)

版权声明:自由转载-非商用-非衍生-保持署名(创意共享3.0许可证)

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/101025.html

相关文章

  • API管理平台XXL-API

    摘要:只需要填写测试的参数值,点击下方运行按钮,即可发起一次接口请求,请求结果将会在下方显示出来保存历史在接口测试界面,在进行接口测试后点击下方保存按钮将会把本次测试数据接口,测试参数等信息保存下来。 《API管理平台XXL-API》 一、简介 1.1 概述 XXL-API是一个简洁易用API管理平台,提供API的管理、文档、Mock和测试等功能。现已开放源代码,开箱即用。 1.2 特性 ...

    SmallBoyO 评论0 收藏0
  • 使用 EOLINKER 进行接口测试的最佳路径 (上)

    摘要:创建测试环境并导入到用例集操作步骤如下动态图创建测试环境并导入到用例集动态图说明第一个页面为测试项目列表页面。第三个页面为前置用例集列表页面。 本文内容: 测试脚本管理:讲述如何在 EOLINKER 上设计测试项目目录结构。 编写测试脚本:讲述如何在 EOLINKER 上编写接口测试脚本。 测试脚本执行及报告:讲述如何在 EOLINKER 上执行接口测试脚本,及如何查看和下载测试报告...

    lordharrd 评论0 收藏0
  • 使用 EOLINKER 进行接口测试的最佳路径 (上)

    摘要:创建测试环境并导入到用例集操作步骤如下动态图创建测试环境并导入到用例集动态图说明第一个页面为测试项目列表页面。第三个页面为前置用例集列表页面。 本文内容: 测试脚本管理:讲述如何在 EOLINKER 上设计测试项目目录结构。 编写测试脚本:讲述如何在 EOLINKER 上编写接口测试脚本。 测试脚本执行及报告:讲述如何在 EOLINKER 上执行接口测试脚本,及如何查看和下载测试报告...

    plokmju88 评论0 收藏0
  • 试探API Blueprint接口文档生成和接口模拟

    前言 今天发现了一个很niubility的东西__API Blueprint__,先给出官网https://apiblueprint.org/。下面是官网给出的介绍: API Blueprint. A powerful high-level API description language for web APIs. 这个可以干什么呢?按照API Blueprint的语法(类似markdown),...

    mist14 评论0 收藏0
  • api 接口管理工具

    摘要:接口管理工具大致分为线上工具和自建工具。安装其他工具上面讲的,不管是线上工具还是自建工具,都是接口集成工具,主要是为了提供数据功能。类似网易云笔记印象笔记的笔记管理工具。 api 接口管理工具 现在,Web 应用的前后端分离事实上已经成为了大家都认可的一种开发方式,前后端分离之后,前端与后端都用接口(api)来沟通,这就需要我们做好 API 接口管理,所以,这次来聊聊 API 接口管理...

    wuyumin 评论0 收藏0

发表评论

0条评论

marser

|高级讲师

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<