后台接口文档工具（前后端api维护文档工具）

本文目录一览：

• 1、常见的接口测试工具有哪些?

• 2、前后端分离，关于接口文档，后端是要先写好接口文档，再进行写代码开发，还是写完代码后再编写接口文档？

• 3、五大接口管理平台比较

• 4、[分享] 利用 ApiPost 生成mock数据

常见的接口测试工具有哪些?

接口一般来说有两种，一种是程序内部的接口，一种是系统对外的接口。

系统对外的接口：比如你要从别的网站或服务器上获取资源或信息，别人肯定不会把数据库共享给你，他只能给你提供一个他们写好的方法来获取数据，你引用他提供的接口就能使用他写好的方法，从而达到数据共享的目的，比如说咱们用的app、网址这些它在进行数据处理的时候都是通过接口来进行调用的。

程序内部的接口：方法与方法之间，模块与模块之间的交互，程序内部抛出的接口，比如bbs系统，有登录模块、发帖模块等等，那你要发帖就必须先登录，要发帖就得登录，那么这两个模块就得有交互，它就会抛出一个接口，供内部系统进行调用。

一、常见接口：

1、webService接口：是走soap协议通过http传输，请求报文和返回报文都是xml格式的，我们在测试的时候都用通过工具才能进行调用，测试。

2、http api接口：是走http协议，通过路径来区分调用的方法，请求报文都是key-value形式的，返回报文一般都是json串，有get和post等方法，这也是最常用的两种请求方式。

二、前端和后端：

在说接口测试之前，我们先来搞清楚这两个概念，前端和后端。

前端是什么呢，对于web端来说，咱们使用的网页，打开的网站，这都是前端，这些都是html、css写的；对于app端来说呢，它就是咱们用的app，android或者object-C（开发ios上的app）开发的，它的作用就是显示页面，让我们看到漂亮的页面，以及做一些简单的校验，比如说非空校验，咱们在页面上操作的时候，这些业务逻辑、功能，比如说你购物，发微博这些功能是由后端来实现的，后端去控制你购物的时候扣你的余额，发微博发到哪个账号下面，那前端和后端是怎么交互的呢，就是通过接口。

前面说的你可能不好理解，你只需记住：前端负责貌美如花，后端负责挣钱养家。

三、什么是接口测试：

接口测试是测试系统组件间接口的一种测试。接口测试主要用于检测外部系统与系统之间以及内部各个子系统之间的交互点。测试的重点是要检查数据的交换，传递和控制管理过程，以及系统间的相互逻辑依赖关系等。

OK，上面是百度百科上说的，下面才是我说的

其实我觉得接口测试很简单，比一般的功能测试还简单（这话我先这样说，以后可能会删O(∩_∩)O哈！），现在找工作好多公司都要求有接口测试经验，也有好多人问我（也就两三个人）什么是接口测试，本着不懂也要装懂的态度，我会说：所谓接口测试就是通过测试不同情况下的入参与之相应的出参信息来判断接口是否符合或满足相应的功能性、安全性要求。

我为啥说接口测试比功能测试简单呢，因为功能测试是从页面输入值，然后通过点击按钮或链接等传值给后端，而且功能测试还要测UI、前端交互等功能，但接口测试没有页面，它是通过接口规范文档上的调用地址、请求参数，拼接报文，然后发送请求，检查返回结果，所以它只需测入参和出参就行了，相对来说简单了不少。

前后端分离，关于接口文档，后端是要先写好接口文档，再进行写代码开发，还是写完代码后再编写接口文档？

两种方式都是可以的,针对不同的团队有不同的选择

一般对于需求分析,设计能力比较强,的团队,推荐使用契约优先的设计模式,也就是先编写接口文档,规定好接口的 请求类型/参数数量/参数类型/返回结果的格式然后搭建模拟服务,然后前后端分别开发,但是这种方式需要比较高的设计能力,以应对需求的变更,设计时需要考虑的方面很多,适合于成熟的团队.

如果需求不确定性较高,甚至频繁变动,上面这种方式,就会有局限性,频繁的需求变更带来的就是频繁的接口契约变更.会拖慢前后端的开发进度,这种时候可以采用,先开发后编写文档的流程,由于频繁的发生变更,这时候团队的沟通显得很重要,项目管理人员一定要十分注意前后端开发的沟通效率,不然项目进度会变得不可控

五大接口管理平台比较

本人程序猿一枚，多年来深陷接口管理的漩涡中，闲来无事的时候，把现有开放的接口管理平台仔细捋了一遍，整理出来分享给大家，各位看官各取所需，都别客气哈。

Eolinker

这是在所有接口管理平台中我觉得做的最好的一个了，首先功能齐全，基本上其他平台上有的，eolinker都具备了，从项目管理到接口管理，支持团队协作，接口测试，版本管理，在线分享，导入导出等等，十分强大，而且功能虽多，界面却很干净整洁，体验也很棒，强烈推荐！

接口详情页，信息完备，接口信息一览无余，还可以随时切换测试，mock，历史，修改，顺便说一句，这里的测试功能支持在线和本地测试（需要下插件），甚至可以构造表达式，想先怎么处理数据都行，超极好用！

除此之外，eolinker甚至还集成格式转换，编码转换，加密解密等等的小工具。如果担心接口数据安全，还可以直接从官网上下一个开源版本安装到本地，不过功能就没有线上的那么强大了，但是基本需求都能满足。讲道理，功能强大到这个地步我是服气的。

RAP

从接口管理的功能上来说，相对eolinker来说就有一些逊色了，文档信息不够详细，团队协作那块第一次用的时候我真的是完全懵逼了，而且界面真的是有些简陋（感觉像是后台开发人员写的界面），不过接口管理的基本功能都有，支持版本管理，mock测试，导入导出，而且是开源的，文档也比较详细，大家有时间的话可以以此为基础开发自己想要的功能咯。

easyAPI

在接口文档方面，虽然比起eolinker来说还是相对简单，不过对于那些喜欢简单接口文档的朋友来说，easyAPI也不失为一个不错的选择，不过在我试用的过程中，界面好像不是很稳定，有些按钮点击时没有反应，图标时可见时不可见。而且因为接口文档和接口测试不是在一个菜单之下的，两个功能之间的转换有些费力。

不过接口测试的功能还是挺不错的，左边填数据，右边显示结果，感觉还是挺直观的，如果能支持本地测试就更好啦。

EasyAPI在主菜单上还有一个接口监控的按钮，不过点击之后页面为空，似乎一个很牛逼的功能——可能是我打开的方式不对吧，另外还有一个网关的功能，据说可以帮助开发者轻松创建、发布、维护、监控和保护任意规模的API，需要购买才能使用，大家如果感兴趣的话可以试试。

Apizza

用过DHC的朋友应该会觉得apizza的界面似曾相识，用户在编辑接口的同时也可以进行接口测试，很方便也很简单，如果只是想使用接口管理平台进行接口管理和接口测试的朋友，apizza不失为一个不错的选择，功能虽不强大，但十分轻巧简单。

showDoc

比起其它接口管理平台，showDoc更像一款支持在线分享的文档工具，直接给用户提供一个富文本编辑器，想要什么格式的自己编写，简单粗暴。这样的话虽然管理接口的时候相对麻烦，但是拓展性挺强，它给个平台，我们想分享什么都行，会议记录啊，项目信息啊，下班后哪吃饭啊...不过相对来说，测试功能就不怎么好用了，有得有失吧，看大家想用来做什么咯。

以上5款接口管理工具的简单介绍完啦，希望对大家有所帮助~

[分享] 利用 ApiPost 生成mock数据

什么是mock？

Mock测试就是在测试过程中，对于某些不容易构造或者不容易获取的对象，用一个虚拟的对象来创建以便测试的测试方法。

有了Mock，前后端人员只需要定义好接口文档就可以开始并行工作，互不影响，只在最后的联调阶段往来密切；后端与后端之间如果有接口耦合，也同样能被Mock解决；测试过程中如果遇到依赖接口没有准备好，同样可以借助Mock；不会出现一个团队等待另一个团队的情况。

这样的话，开发自测阶段就可以及早开展，从而发现缺陷的时机也提前了，有利于整个产品质量以及进度的保证。

ApiPost简介：

ApiPost是一个支持团队协作，并可直接生成文档的API调试、管理工具。它支持模拟POST、GET、PUT等常见请求，是后台接口开发者或前端、接口测试人员不可多得的工具 。

apipost上如何使用mock

您可以将ApiPost 的响应文档当作响应结果通过Mock URL直接请求，并且响应文档支持mockjs语法。

mock地址效果：

将生成的mock URL地址发给前端

您可以将ApiPost生成的mock URL地址发给前端来代替您的接口地址，这样前端就可以使用您模拟的数据进行先一步的调试开发了。当您的接口完成后，再替换回来即可。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。