eolinker接口管理系统使用

Posted on |

简介

EOLINKER 是国内API接口管理解决方案的领军者，是国内最大的在线API接口管理服务供应商，致力于满足各行业客户在不同应用环境中对接口管理全生命周期的个性化需求，提供API开发管理、开发团队协作、自动化测试、网关以及监控等服务，帮助企业实现开发运维一体化，提升开发速度并且降低运维成本。简单来说，eolinker是一款针对接口信息管理的平台，它集成了以下功能：

1、接口信息的录入与导出

2、在线测试

3、团队协作管理

4、开发环境管理

5、支持数据字典的录入

6、用户常用到的小工具

7、对状态码进行管理

8、在线社区讨论

官网：eolinker官网

工作空间

EOLINKER中设计有 工作空间（Work Space） 系统，用户可以创建多个工作空间，可以通过工作空间按照企业内的子公司、部门或者项目进行分离，每个工作空间中开通的产品、协作的人员、项目数据等都不一样，并且工作空间之间的数据相互独立，方便进行管理。在EOLINKER中，可以免费创建无数个工作空间，并且可以加入其他人的工作空间中。因为不同空间的项目数据以及人员是互相独立的，因此您必须要切换到相应的工作空间才可以看到该工作空间下的项目数据。

工作空间

API管理与自动化测试

API研发管理

进入对应界面可以看到API目录，版本号和类型，点击项目查看具体项目详情
项目详情

用的最多一般只有API文档和API快速测试这两个功能，下面详细介绍。

点击API文档，进入API文档界面，可以新建分组，在对应分组里添加对应的API
API文档

点击新建，可以创建新的API
API

其中填写API状态（开发、启用、维护、待定、规划等），URL，API名称，标签，开发负责人，请求参数、返回参数以及成功失败示例。填写对应URL可以定义HTTP请求，包括GET/POST/PUT/DELETE/PATCH/OPTIONS/HEAD等。定义参数则要求给出参数名、参数类型，示例和说明可以选填，示例填写的值会作为测试的参数值。填写完后点击保存即可。

使用Mock API进行测试

在系统交互双方定义好接口之后，我们可以提前进行开发和测试，并不依赖上游系统的开发实现。在测试时使用Mock，可以自由方便的构建配置接口对象的信息参数。

进入API文档详情页面，点击 Mock API 标签，进入 Mock API 的编辑页面，点击新建 Mock API 期望按钮。
Mock API

在弹窗中输入 Mock API 期望的名称以及请求触发条件。
请求触发条件包含以下几种类型：

操作 效果
不填写触发条件 不填写请求参数，或者请求参数没有触发其他的Mock API时，返回预期结果
填写了触发条件 当包含了触发条件所需要的参数时，返回预期结果

点击更多设置按钮，可以得到更丰富的配置选项：
Mock API

在更多配置中，你可以设置：

  1. Mock API 返回的 HTTP Code，默认是200

  2. 返回延迟，可以模拟后端处理请求的延迟效果，默认是0ms，最长3000ms（30s）

  3. Mock API 返回的 HTTP Header

接下来我们设置 Mock API 的返回结果，API Studio 提供了三种Mock API的返回类型：

预期返回数据类型 描述
Json 编辑器 通过UI方式生成Json数据，支持 Mock JS
Raw 返回自定义的静态数据
Javascript 通过编写 Javascript 生成返回数据，支持 Mock JS，数据通过 return 语句返回

Json编辑器

Mock API 的 Json 编辑器支持 Mock JS 语法。
在使用Mock API之前，您可以前往 Mock JS 官网了解语法规则：Mock JS 官方网站

Mock 设置中，您可以设置返回字段的类型、生成规则以及属性值：

设置项 说明
类型 设置返回字段的类型
生成规则 设置属性值的处理方式
属性值 设置字段的值，系统会根据 生成规则 对属性值进行处理，得到最终的Mock数据

比如生成字符串长度介于1~10位的”★”：
Mock API示例

点击预览按钮得到的示例结果：
Mock API示例

如果不需要使用Mock JS，那么您可以直接在属性值填写静态数据即可：
Mock API示例

如果希望系统自动根据字段的类型来生成数据，那么可以不填写生成规则以及属性值。

Raw

当 Json 编辑器无法满足您的需求或者您的数据格式比较复杂的时候，可以选择 Raw 方式填写静态数据。

Javascript

当您希望通过代码生成返回数据时，可以使用编写 Javascript 代码的方式，并使用 return 语句返回数据。

Mock API使用可参考以下教程：

Mock API 的定义及实践

使用 EOLINKER 进行接口测试的最佳路径 (上)

使用 EOLINKER 进行接口测试的最佳路径 (下)

导出接口文档

点击项目概况，点击离线导出项目,可以选择导出eoLinker格式、html格式、企业版支持导出pdf格式和word格式，MD格式。
导出API文档

使用Eolinker的优势

  • 接口信息清晰了

  • 接口更新及时，开发者可以通过对相应接口文档的接口操作，根据现有接口信息进行重新录入，快速保存为接口的新文档

  • 接口操作历史可溯源，接口文档的每一次改动历史应清晰记录下来

  • 接口测试同步完成，eolinker AMS提供接口本地一键化测试功能，只要将信息录入eolinker接口管理平台，你将会省去将接口信息重新复制到测试工具的操作。你只需要点击测试页面，输入测试参数值，便可完成测试。
  • 提供mock测试功能，通过设置假数据以验证接口的可行性。