接口管理_接口管理工具 - CSDN
精华内容
参与话题
  • 常见的API接口管理工具

    万次阅读 2018-11-04 22:40:31
    1、Postman ...幸运的是,Postman可以将调试过的请求保存到Collection中。形成的Collection就可以作为一份简单有效且...对QA来说,使用Postman进行接口测试和接口文档维护是同一件事情,测试即文档,维护成本也很低...

    1、Postman

    Postman是被大家所熟知的网页调试Chrome插件,我们常常用它来进行临时的http请求调试。幸运的是,Postman可以将调试过的请求保存到Collection中。形成的Collection就可以作为一份简单有效且支持在线测试的接口文档,使用同一账号登录就可以做到分享和同步。对QA来说,使用Postman进行接口测试和接口文档维护是同一件事情,测试即文档,维护成本也很低。官网:https://www.getpostman.com

    2、Swagger

    “Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。”简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案。Swagger主要包含了以下4个部分:
    1. Swagger可以直接嵌入项目中,通过开发时编写注释,自动生成接口文档;
    2. Swagger包含了Swagger Editor,它是使用yaml语言的Swagger API的编辑器,支持导出yaml和json格式的接口文件;
    3. Swagger包含了Swagger UI,它将Swagger Editor编辑好的接口文档以html的形式展示出来;
    4. Swagger支持根据定义的接口导出各种语言的服务端或客户端代码。
    官网:https://swagger.io/

    3、RAP2

    RAP来自阿里巴巴,是一个可视化接口管理工具 通过分析接口结构,使用mock动态生成模拟数据,校验真实接口正确性, 围绕接口定义,通过一系列自动化工具提升我们的协作效率。可以在线使用,也可以选择本地部署。一个GUI的WEB接口管理工具。在RAP中,您可定义接口的URL、请求&响应细节格式等等。通过分析这些数据,RAP提供MOCK服务、测试服务等自动化工具。RAP同时提供大量企业级功能,帮助企业和团队高效的工作。官网:http://rapapi.org/platform/home.do

    4、YApi

    YApi是由去哪网前端团队开源的一款接口管理工具,功能强大,可以轻松的自己部署。而且支持使用docker部署,使用成本很低了。官网:https://yapi.ymfe.org

    5、Eolinker

    eolinker是一个接口管理服务网站,如果不想自己部署YApi、Rap2、Swagger等的团队可以使用,免费版的功能对于小型团队来说足够了。官网:https://www.eolinker.com

    6、DOClever

    可以对接口信息进行编辑管理,支持 get,post,put,delete,patch 五种方法,支持 https 和 https 协议,并且支持 query,body,json,raw,rest,formdata 的参数可视化编辑。同时对 json 可以进行无限层次可视化编辑。并且,状态码,代码注入,markdown 文档等附加功能应有尽有。接口调试运行,可以对参数进行加密,从 md5 到 aes 一应俱全,返回参数与模型实时分析对比,给出不一致的地方,找出接口可能出现的问题。如果你不想手写文档,那么试试接口的数据生成功能,可以对接口运行的数据一键生成文档信息。mock 的无缝整合,DOClever 自己就是一个 mock 服务器,当你把接口的开发状态设置成已完成,本地 mock 便会自动请求真实接口数据,否则返回事先定义好的 mock 数据。支持 postman,rap,swagger 的导入,方便你做无缝迁移,同时也支持 html 文件的导出,方便你离线浏览!项目版本和接口快照功能并行,你可以为一个项目定义 1.0,1.1,1.2 版本,并且可以自由的在不同版本间切换回滚,再也不怕接口信息的遗失,同时接口也有快照功能,当你接口开发到一半或者接口需求变更的时候,可以随时查看之前编辑的接口信息。自动化测试功能,目前市面上类似平台的接口自动化测试大部分都是伪自动化,对于一个复杂的场景,比如获取验证码,登陆,获取订单列表,获取某个特定订单详情这样一个上下文关联的一系列操作无能为力。而 DOClever 独创的自动化测试功能,只需要你编写极少量的 javascript 代码便可以在网页里完成这样一系列操作,同时,DOClever 还提供了后台定时批量执行测试用例并把结果发送到团队成员邮箱的功能,你可以及时获取接口的运行状态。团队协作功能,很多类似的平台这样的功能是收费的,但是 DOClever 觉得好东西需要共享出来,你可以新建一个团队,并且把团队内的成员都拉进来,给他们分组,给他们分配相关的项目以及权限,发布团队公告等等。官网: http://doclever.cn

    7、Apizza

    1.项目管理;2.api分类管理;3.自动保存request 和 response,这个可以为以后自动化测试做准备;4.跨域模拟请求5.自动生成文档这个功能很好用,可以直接把参数分析成文档。最后导出成html文档。官网:http://apizza.cc

    8、EasyAPI

    接口文档相对简单,不过对于那些喜欢简单接口文档的朋友来说,easyAPI 也不失为一个不错的选择,界面简单明了,配色粉蓝粉蓝很可爱,不过在我试用的过程中,界面好像不是很稳定,有些按钮点击时没有反应,图标时可见时不可见。而且因为接口文档和接口测试不是在一个菜单之下的,两个功能之间的转换有些费力。同时也有回收站,版本管理等功能,总的来说,就是比 eolinker 简单,比 rap 好看。不过接口测试的功能还是挺强大的,左边填数据,右边显示结果,感觉还是挺直观的,如果能支持本地测试就更好啦。官网:https://www.easyapi.com/

    9、CrapApi

    CrapApi接口管理系统实际上是一个java开源项目。一个由anjularjs+bootstrap+springMVC搭建的免费开源的API接口管理系统(应用接口管理系统)后台开发语言为java,主要技术:anjularjs、bootstrap、springMVC、hibernate、maven Application Programming Interface。演示地址:http://api.crap.cn 或http://api2.crap.cn  账号:super 123456 。系统特点: 系统支持管理员管理、权限控制、角色管理 支持多项目、多模块划分,同时支持私密项目、模块密码访问 支持数据字典管理、支持数据字典密码访问 支持项目错误码管理、支持接口拷贝等功能 支持前端菜单自定义,支持管理员菜单自定义。官网:https://github.com/EhsanTang/CrapApi

    展开全文
  • 当前端需要服务端提供的接口实现动态数据展示和交互时,服务端完成接口开发后会提供一个接口文档给到前端按照文档规范再进行开发。这样模式下往往会出现两种情况:一种是往前端开发的进度往与服务端开发的进度不会...

    在这里插入图片描述
    (想自学习编程的小伙伴请搜索圈T社区,更多行业相关资讯更有行业相关免费视频教程。完全免费哦!)

    前言

    在日常的开发模式里,前端负责页面和动态脚本的处理,服务端负责业务逻辑和接口的实现。当前端需要服务端提供的接口实现动态数据展示和交互时,服务端完成接口开发后会提供一个接口文档给到前端按照文档规范再进行开发。这样模式下往往会出现两种情况:一种是往前端开发的进度往与服务端开发的进度不会完全同步,这就存在了一方等待另一方的情况,这多少会影响整体项目开发进度;另一种就是当前端对接不同的服务端人员所开发的接口,如果没有了统一的接口文档规范,每个人输出的接口文档都不尽相同,在后期对项目接口的更新和维护会是很大的时间成本。

    所以很有必要有一个前后端通用的接口管理平台,简化接口对接和维护的流程。前后端可以通过接口管理平台,制定接口数据和格式,然后通过模拟数据生成假接口,前后端再各自独立开发,直至双方都开发完成后对接真实接口数据进行微调即可。并且通过接口管理平台,开发人员可以更便捷地管理项目所有接口数据。

    这里本文将主要认识学习一下目前国内开源较火的接口管理平台 YApi,看如何使用它帮助我们提高开发效率和便捷对接口的管理。

    本文不会描述 YApi 的安装部署过程,想要详细了解如何部署YApi可以参见文末提供的参考链接:YApi 安装部署,使用 Docker 构建 Yapi

    YApi 介绍

    YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台,以开发、产品、测试人员提供更优雅的接口管理服务为目标,该项目由去哪儿网大前端技术团队开源的,托管在 Github 上,已经 9000 多星。

    YApi 作为 API 管理平台主要提供三大块功能:

    • 项目管理:提供基本的项目分组,项目管理,接口管理功能,成员权限管理
    • 接口管理:提供友好的接口文档,支持多人协作接口编辑功能,以及类 Postman 测试工具便于高效调试接口
    • Mock 服务:基于Mock.js,通过随机数据生成,模拟各种接口数据,充分发挥前后端分离的优势。

    什么是Mock.js
    Mock.js是一个模拟数据生成器,帮助前端开发和原型与后端进度分离,减少一些单调,特别是在编写自动化测试时。

    当然 YApi 还有很多强大的功能,比如自动化测试,插件机制,二次开发等等。

    下图是YApi 官方提供了使用 YApi 的工作流程,从这里可以简单了解下如何在日常开发中使用 YApi。
    在这里插入图片描述

    第一个 YApi

    登录注册

    使用 YApi 前,必须要先有登录账号,所以一开始需要在所搭建的 YApi 网站上注册一个账号,注册成功就可以用用户名或者邮箱进行登录。
    在这里插入图片描述
    注册成功后就会自动登录进入 YApi 首页,后面再次使用就可以直接用账号登录了。

    需要注意的是作为新注册的用户,没有任何分组与项目的权限,只能对“公开项目” 的接口进行搜索、浏览 ,此时需要联系平台管理员将你加入对应项目。

    下图为一个正常账户登录 YApi 首页的基本内容:
    在这里插入图片描述

    1. 首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

    2. 首页左侧展示分组信息,“分组”是“项目”的集合,只有超级管理员可以管理分组。

    3. 首页右侧是分组下的项目和成员列表,点击左侧的某个分组,右侧会出现该分组下的项目和成员信息。

    4. 点击项目右上角的星星即可关注项目,关注的项目可以在“我的关注”页面查看。

    5. 点击头像进入“个人中心”,允许查看和修改个人信息。

    项目接口

    首先在项目列表选择一个项目进入(如果没有可用的项目,一种方式是找管理员分配项目权限,一种是在左上角点击 “添加项目” 新建一个项目),进入项目后可大致看到如下内容:
    在这里插入图片描述

    1. 接口列表,展示该项目的所有接口名称,并且按照文件夹分类,默认都在公共分类下,也可以自定义添加分类。
    2. 测试集合,用于保存接口运行正常的数据信息和接口状态,便于后续直接使用测试集合中的接口测试。
    3. 添加接口,为项目添加接口,默认在公共分类下,需要指定接口名,请求方式和接口路径,保存后自动添加到接口列表下。
    4. 用于接口数据的导入导出,便于接口数据的迁移归档。
    5. 对项目信息的基本设置,如环境地址,接口路径,Mock 设置等。

    现在我们再来看下一个简单接口的页面展示内容:
    在这里插入图片描述
    接口信息框内有四个面板可以切换,分别为预览,编辑,运行和高级 Mock,我们在编辑面板里可以通过接口的请求方式,请求数据,响应数据,接口描述等信息进行编辑,保存后都会在预览面板内清晰展示出来,当需要进行接口测试时就需要在运行面板里操作,里面的操作方式跟 Postman 很相似,相信使用过 Postman 的小伙伴应该能很快上手。

    注意:使用接口测试服务时,如果是 Chrome 浏览器 ,需安装测试增强插件,官方也提供了下载地址和安装教程。

    这里有一个小技巧可以分享下:每次进入接口的运行面板,上次使用请求参数都会被情况,每次都需要重新填写,如果请求接口参数一多就十分繁琐;这里我们可以把测试过的接口通过保存按钮加入到测试集合中,后面可以直接在测试集合中找到所记录的接口和有效的请求参数,并且能直接使用。
    在这里插入图片描述
    高级Mock 一栏则是对接口模拟数据的设置,具体用法在后面会详细介绍。

    到这里,YApi 的简单使用介绍完毕,使用 YApi 进行基本的接口测试和维护应该问题不大了,后续介绍 YApi 的更高级用法和最佳实践。

    Mock 接口

    本节主要描述如何通过 YApi 的 Mock 服务模拟接口的数据。

    首先在接口面板里选择高级Mock一栏,选择添加期望来定义所实现模拟的条件和数据。
    在这里插入图片描述
    添加期望时分为两部分,一块是填关于期望的基本信息,如名称,白名单IP,匹配的参数等,另外一块就是期望模拟的响应数据,如响应头信息,响应体数据,甚至响应时间也可以设置。

    在这里设置响应体数据时,除了使用常规的固定假数据返回,我们可以使用 Mock.js 支持的语法,让假数据随机生成,例如下方的示例模拟一个简单的响应数据: code 为 200 或者 400,message 为重复出现 1~10次的测试两次。
    在这里插入图片描述
    保存之后,我们对接口的 Mock 地址*(预览面板中 Mock 地址链接)*进行多次请求就随机获得以下的请求数据:

    {
    "code": 200,
    "message": "测试测试测试",
    "data": {}
    }
    
    {
    "code": 400,
    "message": "测试测试测试测试测试测试",
    "data": {}
    }
    

    当然除了这样方式定义模拟数据的生成,还有许多丰富的形式,具体的数据定义语法可以参见 Mock.js 提供的官方示例:mockjs.com/examples.ht…

    最佳实践

    接口分级

    YApi 以项目为单位进行接口的管理,基于此还提供的分类的功能,新生成的接口都有默认的分类为公共分类。

    为了能更清晰,更直观有效地管理接口,我们可以从项目的业务角度出发,在 YApi 中将业务转换为接口分类,每个业务分类下管理各自相关的接口,而一些公共接口统一在公共分类中管理,比如下图所示,将订单业务和支付业务分别生成各自的接口分类,在该分类下都是跟自身业务紧密相关的接口。
    在这里插入图片描述

    环境配置

    当日常开发中一个程序都会有不同环境要求,接口请求的地址也不同,为了便于多环境接口的切换,我们可以在项目设置的环境配置 一项添加该项目下接口的多个环境,并且这里增加了全局 header,项目中设置全局 header 值。
    在这里插入图片描述
    除此之外,用户可以在每个环境配置项中定义 global 全局变量的名称和值, 接口运行或者测试集合里面可以通过 {{ global.Name }} 来访问当前环境变量下定义的全局变量。

    设置保存之后,我们就可以在该项目下任一接口的运行面板里切换环境地址,如下
    在这里插入图片描述

    请求配置

    YApi 支持 pre-script, 就是通过自定义 js 脚本方式改变请求的参数和返回的 Response 数据,而这个功能可以满足当我们请求和响应的数据都是通过加密处理的使用场景。

    请求配置的位置同样在项目设置里,针对项目的所有接口生效,对外提供公共变量 context 对象包含的请求和响应的所有数据 。
    在这里插入图片描述
    如果我们需要在一组接口的 URL 上增加一个公共的 token 参数,可以在 Pre-request Script 里写如下脚本:在这里插入图片描述
    而如果我们需要修改响应数据中某个值进行修改,可以填写如下 Pre-response Script 里写如下脚本:
    在这里插入图片描述
    另外,全局变量 context 还提供的工具函数,让我们使用:

    在这里插入图片描述
    结合工具函数,我们就可以进行接口请求时和响应时的加密处理,例如我们需要对响应体中 data 数据进行 Base64 加密,可以定义如下脚本:
    在这里插入图片描述

    数据导入导出

    在数据管理上,YApi 提供了简单而有效的方案来支持数据的导入和导出。

    YApi 支持快速导入其他格式的接口数据,以方便快速添加接口。YApi 目前支持 Postman, Swagger, JSON 数据导入等,方便我们进行接口数据迁移。

    而当我们需要把接口分享给非项目组内的人时,我们可以使用数据导出功能,以 HTML,Markdown 或者 JSON 的格式导出项目接口文档数据,只需要将文档文件给到他人就行了。
    在这里插入图片描述

    结语

    本文主要记录了开源接口管理平台- YApi的基本介绍和使用。面对多人多项目的团队开发,有个统一的管理平台来进行接口管理和维护,还是很有必要的,也是很基础的,对项目的开发效率提高也有很大帮助,如果你有正在使用 YApi 有更好的使用姿势或者遇到什么坑,更或者在使用过其他的接口管理平台框架,也欢迎留言交流讨论?。

    展开全文
  • 接口规范说起来大,其实也就那么几个部分,接口规范、接口管理工具、接口文档编写、开发文档编写。 接口规范定义 一、协议规范 为了确保不同系统/模块间的数据交互,需要事先约定好通讯协议,如:TCP、HTTP、...

         无规矩不成方圆,为了开发人员间更好的配合,我特意整理了这么一篇文档供大家参考学习,如有意见、见解,请在评论区留言探讨。

         接口规范说起来大,其实也就那么几个部分,接口规范、接口管理工具、接口文档编写、开发文档编写

     

    接口规范定义

    一、协议规范

        为了确保不同系统/模块间的数据交互,需要事先约定好通讯协议,如:TCP、HTTP、HTTPS协议。为了确保数据交互安全,建议使用HTTPS协议。

     

    二、接口路径规范

        作为接口路径,为了方便清晰的区分来自不同的系统,可以采用不同系统/模块名作为接口路径前缀。

    格式规范如下:

        支付模块   /pay/xx

        订单模块  /order/xx

     

    三、版本控制规范

        为了便于后期接口的升级和维护,建议在接口路径中加入版本号,便于管理,实现接口多版本的可维护性。如果你细心留意过的话,你会发现好多框架对外提供的API接口中(如:Eureka),都带有版本号的。如:接口路径中添加类似"v1"、"v2"等版本号。

    格式规范如下:

          /xx/v1/xx

    更新版本后可以使用v2、v3等、依次递加。

     

    四、接口命名规范

        和Java命名规范一样,好的、统一的接口命名规范,不仅可以增强其可读性,而且还会减少很多不必要的口头/书面上的解释。

        可结合【接口路径规范】、【版本控制规范】,外加具体接口命名(路径中可包含请求数据,如:id等),建议具体接口命名也要规范些,可使用"驼峰命名法"按照实现接口的业务类型、业务场景等命名,有必要时可采取多级目录命名,但目录不宜过长,两级目录较为适宜。

    格式规范如下:

        /user/v1/sys/login     用户服务/模块的系统登录接口

       /zoo/v1/zoos/{ID}        动物园服务/模块中,获取id为ID的动物

     

    具体接口命名,通常有以下两种方式:

    • 接口名称动词前/后缀化

        接口名称以接口数据操作的动词为前/后缀,常见动词有:add、delete、update、query、get、send、save、detail、list等,如:新建用户addUser、查询订单详情queryOrderDetail。

    • 接口名称动词+请求方式

         接口路径中包含具体接口名称的名词,接口数据操作动作以HTTP请求方式来区分。常用的HTTP请求方式有:

        GET:从服务器取出资源(一项或多项)。

        POST:在服务器新建一个资源。

        PUT:在服务器更新资源(客户端提供改变后的完整资源)。

        PATCH:在服务器更新资源(客户端提供改变的属性)。

        DELETE:从服务器删除资源。

    如:

        GET /zoo/v1/zoos:列出所有动物园

        POST /zoo/v1/zoos:新建一个动物园

        GET /zoo/v1/zoos/{ID}:获取某个指定动物园的信息

        PUT /zoo/v1/zoos/{ID}:更新某个指定动物园的信息(提供该动物园的全部信息)

        PATCH /zoo/v1/zoos/{ID}:更新某个指定动物园的信息(提供该动物园的部分信息)

        DELETE /zoo/v1/zoos/{ID}:删除某个动物园

        GET /zoo/v1/zoos/{ID}/animals:列出某个指定动物园的所有动物

        DELETE /zoo/v1/zoos/ID/animals/ID:删除某个指定动物园的指定动物

     

    五、请求参数规范

    • 请求方式:

    按照GET、POST、PUT等含义定义,避免出现不一致现象,对人造成误解、歧义。

    • 请求头:

    请求头根据项目需求添加配置参数。如:请求数据格式,accept=‘application/json’等。如有需要,请求头可根据项目需求要求传入用户token、唯一验签码等加密数据。

    • 请求参数/请求体:

            请求参数字段,尽可能与数据库表字段、对象属性名等保持一致,因为保持一致最省事,最舒服的一件事。

     

    六、返回数据规范

        统一规范返回数据的格式,对己对彼都有好处,此处以json格式为例。返回数据应包含:返回状态码返回状态信息具体数据。

    格式规范如下:

    {
    
        "status":"000000",
    
        "msg":"success",
    
        "data": {
    
            //json格式的具体数据
    
        }
    
    }

            返回数据中的状态码、状态信息,常指具体的业务状态,不建议和HTTP状态码混在一起。HTTP状态,是用来体现 HTTP链路状态情况,如:404-Not Found。HTTP状态码和json结果中的状态码,并存尚可,用于体现不同维度的状态。

     

    接口管理工具推荐

        接口开发完后,最终的目的是提供给其他系统/模块来使用的,因此,接口的管理是必不可少的。

    接口管理的痛点

        接口的管理常常面临很多的痛苦,这里就列举几个常见的,看看你是否也遇到过。

    • 系统/模块太多、接口太多,没有系统统一管理所有接口。
    • 代码修改后,接口文档没有及时更新,造成接口文档和实际接口不一致的现象。
    • 接口管理系统自主研开发成本高。
    • 接口管理缺少接口mock功能。

    接口管理工具推荐

           在日常工作过程中用过、接触过的接口管理工具也是不尽其数,下面介绍你可能使用过、没有使用过的接口管理工具,同时也介绍这些接口管理工具的优缺点。   

    word

          相信大家之前用来管理接口比较多的应该是word吧,开发人员将系统的接口维护在word文档里,不管是组内沟通还是和其他团队的接口沟通都离不开这些接口文档,每次修改文档和代码都要同步修改。相信使用word的缺点大家应该也很清楚,就是维护和管理很麻烦,我们经常会遇到文档和代码不一致的情况,大部分不一致都是因为接口因为种种原因修改了,开发人员大部分都是只改了代码里的接口实现,而没有去修改接口文档。而且word文档搜索接口也很麻烦,没办法建全局索引,只能一个个文档点开查看,想想就很痛苦。但不可否认的是,word对于一些小团队用起来还是挺方便的,不用搭建系统,给谁一看就明白。

    自建接口管理系统

           对于一些有一定规模的企业,在各项工程管理活动上都非常正规,各种ISO标准要遵守,自然对接口管理的要求也非常高,之前在国有银行,我们就是自建了接口管理系统,自建还是很消耗人力成本的,从开发到后续运维,都要消耗人力,但是自建的好处就是,可以根据公司的要求进行各种花样的定制,我们之前在接口管理系统中加入了很多好用的定制功能,例如接口被哪些系统调用、接口是在哪个批次投产又在哪个批次做过变更等等,这对于架构师来说非常好用,用于分析接口影响范围非常方便。目前开源的接口管理系统还没有能做到这些定制化功能的。

    wiki

          之前在小团队的时候还用过一段时间的私有wiki,wiki特别适合于小团队高速线性迭代开发,在wiki上看到的就是最新的接口,团队内所有成员看到的都是一样的,如果接口有变化,相关开发人员修改后立即生效,保证了顺畅的接口沟通。但是wiki的缺点也很多,接口文档只是静态页面,无法实现一些动态效果,无法实现追溯等等缺点。

    RAP

           相信很多互联网公司都在使用RAP,RAP是阿里开源的一套接口管理系统,RAP可以比较方便的管理公司所有系统的接口,同时还有比较完善的权限管理,还可以做接口mock,方便开发人员在接口功能还没有完成的时候能够及时发布出去,给调用方去使用。但是RAP的缺点就是每个接口都需要维护进去,接口修改后也需要及时维护,当时我们在使用的时候遇到的最大的问题也是经常碰到接口没有及时维护的问题。

    swagger

          上面说的那些接口管理工具,其实都有一个很大的问题就是修改代码后需要同步维护接口文档,但是让程序员去修改文档是很难的,大部分程序员都比较讨厌维护各类文档。当我第一次了解到swagger的时候,发现这简直就是为程序员定制的接口管理工具,swagger定义了很多注解,在对接口加上swagger相关的注解,当接口代码修改后,swagger在工程启动后会根据代码自动生成最新的接口html文档,同时swagger提供了mock接口模拟的功能,也能够更加方便的模拟接口,并且还能够在swagger界面上直接发起接口调用,可以方便调用方在还没写代码的时候就能够尝试下接口调用后的结果。

          看了那么多swagger的优点,下面也说说swagger的缺点,那就是swagger是跟随着每个工程一起启动的,这就导致每个工程都有一个swagger的访问地址,如果公司系统很多的话,那就会导致查看不同系统的接口都要到不同的地址去查看,每个开发都要自己收藏好各个系统的swagger地址。有些公司也自己开发了统一网关,将所有swagger的接口地址聚合起来,但是多少还是涉及到一些开发工作的,而且做的还不一定很完善。

    Easy Mock

            官网的这张图基本上介绍清楚了easymock的核心功能,这其中我最看重的功能有两块,一个是能够集成swagger接口并集中管理所有接口,另一个就是响应式数据。

           EasyMock能够根据swagger接口的地址自动导入所有swagger接口,非常方便,对于非swagger的接口也可以手工维护进去,这样可以很方便的做到全公司接口统一维护,而且也有比较完善的接口权限管理,方便分组管理。但缺点就是过于庞大,可能太适合小一点项目或团队。

     

          上面提及到接口管理工具,大家可根据自己项目的规模、需求,进行实际选择,切记生搬硬套。

     

    欢迎微信扫码下面二维码,关注微信公众号【程序猿技术大咖】,进行更多交流学习!

    展开全文
  • api 接口管理工具

    千次阅读 2019-01-28 19:26:29
    api 接口管理工具 API 接口管理工具大致分为线上工具和自建工具。 1. 线上工具 比较热门的线上工具有: eolinker apizza:界面与 postman 比较像 easyapi apiview 2. 自建工具 企业一般都采用自建工具,自己维护...

    api 接口管理工具

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

    1. 线上工具

    比较热门的线上工具有:

    2. 自建工具

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

    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 的安装步骤要麻烦一些,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 其实并不是一个工具,而是一系列工具,或者说叫一个生态:

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

    这套工具对后端非常有用,特别是 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)

    展开全文
  • Linux下部署DoClever接口管理平台

    万次阅读 2019-10-19 16:10:30
    本次是基于centos7版本下进行安装的,用于开发环境。经过本人实测可用。 1、 配置node环境 用这个版本:v6不支持wget https://nodejs.org/dist/v8.16.0/node-v8.16.0-linux-x64.tar.gz 1.cd /usr/local ...
  • 接口规范说起来大,其实也就那么几个部分,接口规范、接口管理工具、接口文档编写、开发文档编写。以下将详细介绍,下面进入正文:接口规范文档具体内容如下:一:协议规范二:域名规范三:版本控制...
  • 几款常见接口管理平台对比

    千次阅读 2020-05-11 22:59:16
    为了方实现接口规范,团队协作,工程规范,接口Mock,接口测试等功能,项目开发需要一个接口管理平台,通过查询发现国内主要有以下几款接口管理平台,并对这几款接口管理平台进行了对比,结果如下 Eolinker EOLINKER...
  • Swagger API接口管理

    万次阅读 2016-12-30 11:25:31
    介绍 Swagger API框架,用于管理项目中API接口,属当前最流行的API接口管理工具。 Swagger功能强大,UI界面漂亮,支持在线测试等! Swagger包括库、编辑器、代码生成器等很多部分,Swagger UI是一个API在线文档...
  • RAP接口管理工具

    千次阅读 2018-06-06 22:45:31
    RAP是阿里开源的接口管理工具,主要包括开发团队/项目的管理,编写API接口,MOCK服务,接口测试,生成接口文档等功能。并且RAP是可以在本地环境中进行部署使用的(linux,windows皆可),这里也建议本地部署,第一不...
  • RestCloud API接口管理平台

    千次阅读 2018-07-29 22:25:25
    RestCloud API接口管理平台  RestCloud API管理平台是完全自主研发的企业级统一API接口管理平台,本平台不但可以从Java代码中的注解自动扫描生成API文档还能通过OpenAPI3.0标准文档、手工等方式导入企业的其他API...
  • yapi 接口管理平台手册

    千次阅读 2020-03-12 11:27:27
    文章目录前言背景、现状、意义mock测试yapi基于项目的管理API接口管理mock 服务器使用服务端使用路径客户端使用路径参考资料 前言 ​ 本篇旨在让相关开发人员理解引入 yapi 的目的以及对 mock 测试和 yapi 的功能有...
  • API Manager PHP 接口管理工具

    千次阅读 2020-06-29 18:01:27
    API Manager PHP 接口管理工具 接口开发过程中必不可少的的接口管理工具,今天推荐一个 API Manager 接口管理工具,是通过php编写的超轻量级工具,虽然作者只写了一些简单功能,但是可以自己扩展自己需要的功能,...
  • 前端项目的接口管理方案----构思

    千次阅读 2020-08-04 17:14:04
    一般来讲,现在百分之90的开发方式都是前端端分离,通俗来讲就是...我个人观点认为,封装就应该是拆分一层又一层,最终目的就是为了方便维护,方便拓展,方便管理。 传统的代码,也是我看见项目最烦的一种代码: ...
  • API接口管理平台-rap

    万次阅读 2016-02-25 11:44:37
    因为公司多个项目组并行,多次出现因为分支交叉使用导致影响其他项目组线上功能的情况,制定了几条规则来解决这一情况,其中一条规则就是对于各个项目组API接口的管理工作。...所以需要一个API接口管理平台,最后通过
  • rap2 接口管理工具

    万次阅读 2018-01-25 17:23:03
    安装方法和地址详见:rap2的安装
  • 基于swagger做接口管理

    千次阅读 2016-05-11 20:57:05
    笔者目前正在搭建一套API服务框架,考虑到客户端能够更方便的调用API服务(这里说的更方便是指避免不厌其烦地解说各接口需要的参数和返回结果),于 是决心为每个接口生成详细的说明文档。网上搜索了一下,发现了...
  • Swagger包括库、编辑器、代码生成器等很多部分,这里我们主要讲一下Swagger Editor。这是一个完全开源的项目,并且它也是一个基于Angular的成功案例,我们可以下载源码并自己部署它,也可以修改它或集成到我们自己的...
  • java开源项目CrapApi接口管理系统

    万次阅读 2016-11-15 23:29:19
    应用接口管理,后台开发语言为java,主要技术:anjularjs、bootstrap、springMVC、hibernate、maven Application Programming Interface 演示地址:http://api.crap.cn 账号:super 123456 (请勿修改密码,谢谢)...
  • 本文安利了一个阿里前端团队出品的API管理工具--RAP。通过本文你可以了解: 1,RAP是什么及这类工具有什么作用 2,RAP使用入门 3,项目中使用RAP的实例
1 2 3 4 5 ... 20
收藏数 1,396,152
精华内容 558,460
关键字:

接口管理