文档章节

eoLinker-AMS接口管理系统 快速入门

彦臣
 彦臣
发布于 2018/01/11 15:01
字数 2292
阅读 57
收藏 0

创建项目

在eoLinker可以无限制创建项目,在您注册之后,我们也会为您自动创建一个示例项目,讲解相关的基本操作。

如果您需创建项目,仅需在 项目列表 页面,点击 新增项目 按钮:

随后在弹框中填写项目的相关信息,点击 确定 即可:

其中,版本号 和 项目类型 仅用于标注,并无实际用途。

------------------------------------------------------------------------------------------------------------

创建API接口

在项目详情页,点击侧边栏 API接口 ,进入API接口管理页面:

点击 新建接口 按钮,进入 API编辑页面 :

页面上方是接口编辑的三大模块:

  1. 基础信息:包含所有API相关的文档信息。eoLinker AMS提供目前业内最强大、全面的文档系统,一般情况下该文档系统已经可以满足80%以上的API管理需求。
  2. 详细说明:eoLinker AMS提供了富文本以及Markdown双编辑器支持,您可以在此编写详细的API说明信息,并且支持插入图片!可以满足所有的API文档记录需求。
  3. 高级Mock:提供自动生成Mock数据的功能,在此选项卡下可以编辑Mock数据的生成规则。eoLinker AMS全面支持MockJS并且在其之上进行了诸多优化,使得MockJS更加强大和易用。关于Mock的详细使用说明请查看 Mock章节

基础信息中,首先填写API接口的必要信息:

  1. 分组:最多支持二级分组,对API进行适当的归类有助于提高管理效率
  2. 状态:表示当前API的运行状态【启用、维护、弃用】,仅作为标识方便核查
  3. URL:API的地址,其中包括请求的方式,以及协议和路径,在此建议填写API的相对路径(如/user/login,忽略前面的www.xxx.com根路径),后期通过eoLinker AMS提供的强大的 环境管理 功能,统一改变所有API的根路径,相关的教程请看 环境管理章节
  4. 名称:接口的描述
  5. 星标★:注意右侧红色方框部分,您可以为接口标注星标,方便团队间沟通,如表示改接口存在Bug,或者表示需要对接等。

请求头部中,你可以手动输入接口的头部信息,也可以使用 导入头部 的功能批量导入:

注意,导入的每条头部信息之间通过 换行 表示结束,如:

 
  1. Access-Control-Allow-Credentials:true
  2. Access-Control-Allow-Headers:x-requested-with,content-type,Cache-Control,Pragma,Date,x-timestamp
  3. Access-Control-Allow-Methods:POST, GET, OPTIONS
  4. Access-Control-Allow-Origin:https://www.eolinker.com
  5. Connection:keep-alive
  6. Content-Length:0

请求参数部分,eoLinker提供了三种最常用的数据格式(红色部分):

  1. 智能表单[form-data]:支持无限层级结构,并且能对每个参数设定非常详细的示例和值可能性等,同时eoLinker提供了业内唯一的表单转Json方案,可以将表单转为同样格式的Json数据进行发送。
  2. RESTful:支持无限层级结构,并且可以替换接口URL中的相关绑定参数。
  3. 源数据[RAW]:所有非表单和Restful类型的参数均可通过源数据进行发送,如Json、XML或者其他自定义的数据格式等。

操作列(蓝色部分)分别是:

  1. 参数的更多设置:如参数的值可能性(eoLinker首创功能,全面记录该参数拥有的各种值以及含义)、参数示例等。
  2. 拖动排序
  3. 删除

更多参数设置

返回参数部分和请求参数部分大同小异,不做赘述。

返回示例 部分提供了 成功 以及 失败 两种结果的记录,同时返回记录也可以作为接口的简易Mock功能,当接口文档保存以后,将会得到两个统一前缀的URL地址,访问该地址可以得到实现记录好的 成功结果 或者 失败结果

(上图为保存后的返回示例,红色部分的简易Mock的地址,访问即可得到相应的结果,如图中的返回结果为ok)

最后点击页面右上方的 保存 或者 继续添加 按钮,即可完成当前接口的创建工作。

熟练之后,创建一个接口文档的时间约为3~5分钟,并且可以连同接口测试一起进行,极大提高开发效率。

------------------------------------------------------------------------------------------------------------

基础测试(在线接口测试)

eoLinker提供了非常强大的在线API接口测试功能,在使用之前,请先确保已经安装 eoLinker自动化测试增强插件 ,该插件为您提供了API的在线、跨域、文件以及自动化测试的功能。

插件获取地址:请点击这里获取插件

eoLinker通过测试插件提供了非常多的 独有的 测试功能,包括但不限于:

  1. 参数构造器:一键对参数进行任意次数的处理
  2. 智能表单:根据请求方式自动修改参数发送方式以及拼接参数
  3. 在线、跨域、本地测试:不管服务器部署在任何地方,即使是localhost也可以在线进行测试
  4. 文件测试:请求参数支持文件格式
  5. 支持Restful类型的API测试:自动将参数替换url中的匹配部分
  6. 支持Raw源数据类型的API测试:支持json、xml甚至是用户自定义结构的请求参数。
  7. 支持查看测试的详细结果,包括头部、返回值以及时间等
  8. 支持保存测试历史,并且随时切换到历史的测试记录
  9. 支持对返回值进行格式化,并且能够在新窗口中打开

对每个功能的具体介绍请查看本章节下的对应教程

插件安装完成之后刷新页面,在 接口详情页 上方点击 测试 选项卡,会出现蓝色部分提示“目前正在使用eoLinker测试插件进行测试”。

然后您可以在下方填写测试参数等,点击发送按钮即可得到测试结果!

------------------------------------------------------------------------------------------------------------

基础测试(在线接口测试)

eoLinker提供了非常强大的在线API接口测试功能,在使用之前,请先确保已经安装 eoLinker自动化测试增强插件 ,该插件为您提供了API的在线、跨域、文件以及自动化测试的功能。

插件获取地址:请点击这里获取插件

eoLinker通过测试插件提供了非常多的 独有的 测试功能,包括但不限于:

  1. 参数构造器:一键对参数进行任意次数的处理
  2. 智能表单:根据请求方式自动修改参数发送方式以及拼接参数
  3. 在线、跨域、本地测试:不管服务器部署在任何地方,即使是localhost也可以在线进行测试
  4. 文件测试:请求参数支持文件格式
  5. 支持Restful类型的API测试:自动将参数替换url中的匹配部分
  6. 支持Raw源数据类型的API测试:支持json、xml甚至是用户自定义结构的请求参数。
  7. 支持查看测试的详细结果,包括头部、返回值以及时间等
  8. 支持保存测试历史,并且随时切换到历史的测试记录
  9. 支持对返回值进行格式化,并且能够在新窗口中打开

对每个功能的具体介绍请查看本章节下的对应教程

插件安装完成之后刷新页面,在 接口详情页 上方点击 测试 选项卡,会出现蓝色部分提示“目前正在使用eoLinker测试插件进行测试”。

然后您可以在下方填写测试参数等,点击发送按钮即可得到测试结果!

 

------------------------------------------------------------------------------------------------------------

添加团队成员

eoLinker AMS中提供了强大的团队协作功能。

项目详情页,点击侧边栏 协作管理,在右侧输入想要加入的成员的账号(用户名、手机号、邮箱),点击 搜索用户 按钮

对想要加入的成员点击 添加 即可:

当你需要大量邀请成员加入时,可以通过 生成邀请链接功能,批量导入成员:

 

------------------------------------------------------------------------------------------------------------

在线分享项目

在eoLinker AMS中,您可以一键将项目通过连接分享给其他人。

在 项目概况页,点击其他功能下的 在线分享项目 按钮:

  1. 在弹出框中点击 启用分享 按钮,然后点击复制分享链接,最后点击 保存 按钮既可。

  2. 如果您需要对分享的项目进行加密(需要正确输入密码才能查看),点击 启用加密 按钮,输入密码,最后点击 保存 按钮既可。

------------------------------------------------------------------------------------------------------------

今天先到这,欢迎大家提意见和补充内容哈,谢谢各位!

© 著作权归作者所有

彦臣
粉丝 9
博文 52
码字总数 45691
作品 4
广州
程序员
私信 提问
API 接口管理系统 Java 版 - eoLinker-API-Management-for-Java

eoLinker-AMS 接口管理系统开源版 - For Java 简介 eoLinker是国内最大的在线API接口管理平台,提供自动生成API文档、API自动化测试、Mock测试、团队协作等功能,旨在解决由于前后端分离导致...

彦臣
2018/04/13
5.7K
1
接口管理系统 eoLinker-AMS 开源 JAVA 版 V1.0 发布

eoLinker是在线API接口管理平台,旨在解决由于前后端分离导致的开发效率低下问题,现已为Google、IBM、IntraMirror、腾讯、百度、网易、中国联通、中国移动、华为、中外运、海尔、拉卡拉、神...

彦臣
2018/04/13
2.3K
4
接口管理系统开源版 --eoLinker

一.概况 eoLinker API Management System(AMS)是一款帮助企业开发人员进行在线管理接口文档、进行自动化测试、团队协作的工具,它旨在提高企业项目的接口管理水平,提升开发速度并且降低运...

ProLinker
2017/11/27
13.7K
17
接口管理系统 eoLinker-AMS 开源版 V3.1.6 正式发布

eoLinker API Management System(AMS)是一款帮助企业开发人员进行在线管理接口文档、进行自动化测试、团队协作的工具,它旨在提高企业项目的接口管理水平,提升开发速度并且降低运维成本。...

彦臣
2017/12/08
1K
8
接口管理系统 eoLinker-AMS 开源版 V4.0 发布更新

eoLinker API Management System(AMS)是一款帮助企业开发人员进行在线管理接口文档、进行自动化测试、团队协作的工具,它旨在提高企业项目的接口管理水平,提升开发速度并且降低运维成本。...

彦臣
2018/06/15
3.7K
3

没有更多内容

加载失败,请刷新页面

加载更多

rime设置为默认简体

转载 https://github.com/ModerRAS/ModerRAS.github.io/blob/master/_posts/2018-11-07-rime%E8%AE%BE%E7%BD%AE%E4%B8%BA%E9%BB%98%E8%AE%A4%E7%AE%80%E4%BD%93.md 写在开始 我的Arch Linux上......

zhenruyan
今天
5
0
简述TCP的流量控制与拥塞控制

1. TCP流量控制 流量控制就是让发送方的发送速率不要太快,要让接收方来的及接收。 原理是通过确认报文中窗口字段来控制发送方的发送速率,发送方的发送窗口大小不能超过接收方给出窗口大小。...

鏡花水月
今天
10
0
OSChina 周日乱弹 —— 别问,问就是没空

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @tom_tdhzz :#今日歌曲推荐# 分享容祖儿/彭羚的单曲《心淡》: 《心淡》- 容祖儿/彭羚 手机党少年们想听歌,请使劲儿戳(这里) @wqp0010 :周...

小小编辑
今天
1K
11
golang微服务框架go-micro 入门笔记2.1 micro工具之micro api

micro api micro 功能非常强大,本文将详细阐述micro api 命令行的功能 重要的事情说3次 本文全部代码https://idea.techidea8.com/open/idea.shtml?id=6 本文全部代码https://idea.techidea8....

非正式解决方案
今天
5
0
Spring Context 你真的懂了吗

今天介绍一下大家常见的一个单词 context 应该怎么去理解,正确的理解它有助于我们学习 spring 以及计算机系统中的其他知识。 1. context 是什么 我们经常在编程中见到 context 这个单词,当...

Java知其所以然
昨天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部