接口管理|接口管理操作手册,接口管理是什么意思-eolink官网

【接口管理模块】用于创建、维护http类型的接口测试用例。

二、使用方法

进入【接口管理模块】，可以对测试用例进行管理，包括查询用例，新增用例，编辑用例，删除用例等。

1、用例查询

用例查询功能：可使用用例名称，业务类别，服务域名，接口uri对用例进行筛选和查询；

用例查询支持四种方式组合查询，查询为全文匹配。

2、新增用例

点击按钮，弹出”添加用例“页面，填写用例信息，点击“确定”保存。

【服务域名】从下拉菜单中选择域使用的名域。如下拉选项中不存在欲使用的域名，请在【oauth管理】模块添加和维护。示例：renmai-core-server-cloud.rmasset.beta

【用例类别】该用例的类别信息，用于归类一类测试用例。如“贷前放款”，”贷后还款“等等；
【用例名称】用例的描述信息
【调用接口】接口路径（不能把请求参数写在该栏中）

【请求方式】POST或GET
【加解密方法】可选填，接口不需要执行加解密不需选择该项。如需要增加加密方法，请联系平台进行新增配置。
【请求参数】为请求所需的字段，示例：?coreLendRequestId=20003302569&repaidTime=2019-10-11%2000%3A00%3A00&repayAmount=0.01

【请求报文】接口请求报文，为JSON格式；

示例：{
"collectionCompany": "ZHONGAN",
"coreCustomerId": 1891622,
"withDrawAmount": 1,
"withDrawId": 1569823639003
}

【开启依赖】标识该用例执行是否需的执行其他接口请求作为前置条件，需要执行前置条件填 1 ，不需要填 0；
【预期结果】

接口预期返回的报文；
示例：{
"transCode": 1,
"transMessage": "OK",
"data": [{
"phase": 2,
"principal": 0.00,
"interest": 0.01,
"penaltyFee": 0,
"overDueFee": 0,
"phaseServiceFee": 0,
"insuranceFee": 0
}]
}
用例结果校验有两种方式：1、json比对，2、关键字段比对

【随机参数】请求参数中需要随机取值的字段，后台会对该字段取随机值进行赋值；；【
【标识字段】该用例的唯一标识，为必填；示例：OverdueRepay

*以上对号勾选的项目为必填项

3、编辑用例

点击一条用例”操作栏“中的”编辑“按钮，弹出”编辑“用例页，在编辑页可对用例相关信息进行编辑和修改，点击“确定”保存编辑后的用例。

【服务域名】下拉菜单中选择域使用的名域。如下拉选项中不存在欲使用的域名，请在【oauth管理】模块添加和维护。示例：renmai-core-server-cloud.rmasset.beta
【用例类别】该用例的类别信息，用于归类一类测试用例。如“贷前放款”，”贷后还款“等等；
【用例名称】用例的描述信息
【调用接口】接口路径

【请求方式】POST或GET
【加解密方法】可选填，接口不需要执行加解密不需选择该项。如需要增加加密方法，请联系平台进行新增配置。
【请求参数】为请求所需的字段，多个字段用英文”,“分开，示例：?coreLendRequestId=20003302569&repaidTime=2019-10-11%2000%3A00%3A00&repayAmount=0.01
【请求报文】接口请求报文为JSON格式；
【开启依赖】标识该用例执行是否需的执行其他接口请求作为前置条件，需要执行前置条件填 1 ，不需要填 0；
【预期结果】接口预期返回的报文；
【随机参数】请求参数中需要随机取值的字段，后台会对该字段取随机值进行赋值；；
【标识字段】该用例的唯一标识，为必填；

*以上对号勾选的项目为必填项

4、删除

点击一条用例”操作栏“中的”删除“按钮，可删除该条用例，备注：谨慎操作，删除后不可恢复该用例数据。

5、添加依赖

点击一条用例”操作栏“中的”添加依赖“按钮，可添加该条用例执行所依赖的前置条件，如：对一条用例添加多个依赖执行的前置用例。

【依赖顺序】一条用例添加多个依赖执行的”前置用例“。依赖顺序为前置用例执行的顺序，应填写正整数，如1，2，3...，错误的依赖顺序可导致用例执行失败；”前置用例“目前支持在数据库中修改，尚不支持其他入口，请谨慎添加；如需修改，请联系管理员。

【服务域名】下拉菜单中选择域使用的名域。如下拉选项中不存在欲使用的域名，请在【oauth管理】模块添加和维护。示例：renmai-core-server-cloud.rmasset.beta
【请求方式】POST或GET；
【调用接口】接口路径
【请求参数】为请求所需的字段，多个字段用英文”,“分开，示例：?coreLendRequestId=20003302569&repaidTime=2019-10-11%2000%3A00%3A00&repayAmount=0.01
【请求报文】接口请求报文为JSON格式；
【随机参数】请求参数中需要随机取值的字段，后台会对该字段取随机值进行赋值；
【期望结果】用例的预期返回报文；
【继承字段】测试用例中依赖前置用例请求中的字段名称。
【标识字段】该用例的唯一标识，为必填；
【继承返回配置】使用当前接口返回内容中指定字段(如:coreRequestId)的取值,替换最终测试接口的请求参数的取值(如:2001234),书写格式为:{'coreRequestId':'2001234'}
。

*以上对号勾选的项目为必填项

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

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

这里本文将主要认识学习一下目前国内口碑较好的接口管理平台 Eolinker，看如何使用它帮助我们提高开发效率和便捷对接口的管理。
本文不会描述Eolinker的安装部署过程，因为Eolinker不像其他同类的工具需要部署，是有Saas版本的。

Eolinker介绍
Eolinker 是一家专注提供 API 生命周期管理产品的公司，旗下产品线覆盖API的生成、API研发管理、API自动化测试、API监控、API微服务网关、API开放平台等应用场景。同时支持Saas版本和本地化部署。
Eolinker作为API管理平台，结合了测试驱动和文档驱动的概念，形成了更为合理的开发流程，对API开发的全生命周期进行了合适的规划和功能铺设。

第一个 Eolinker项目
登录注册的操作就不说了，注册后创建或者加入个人空间，就可以开始操作自己的第一个API项目，可以创建也可以导入，然后就可以根据自己的需要搭建API文档，一键发起测试，或者同时对多个测试用例进行测试。

团队协作
同时Eolinker也有强大的协作功能

当 API 文档发生变更时自动通知相关成员，快速连通对接的前后端开发人员；
远程协作时直接对 API 文档进行评论标注，避免后期沟通找不到依据；
查看、回滚、对比API编辑历史，可进行不同版本的差异对比。

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

上文就是小编给大家整理的接口管理操作手册,接口管理是什么意思。

接口管理操作手册,接口管理是什么意思

多平台统一管理软件接口，如何实现多平台统一管理软件接口

Flask接口签名sign原理与实例代码浅析

java中的接口是类吗

推荐文章

接口调用是什么意思？几种常用接口调用方式

接口设计原则

8款在线 API 接口文档管理工具

api管理系统是什么？

什么是接口调试？接口调试的步骤有哪些？

api 接口管理系统有哪些？

接口测试有几种测试方法

API文档生成工具有哪些？

微服务和api网关区别

交换机配置步骤

最近发表

热评文章

在线接口文档管理工具推荐，支持在线测试，HTTP接口

开源的在线接口文档wiki工具Mindoc的介绍与使

如何优雅的进行接口设计？接口设计的六大原则是什么？

什么是API测试,api检测公司

软件接口设计怎么做？前后端分离软件接口设计思路

接口管理平台推荐，几大接口管理平台总有一款适合你！