eoLinker-AMS接口管理系统 快速入门
2018-01-11 00:00
441 查看
摘要:本篇内容主要为AMS的快速入门，适用于线上Free、PRO版本，并部分适用于独立EID、开源版本，敬请留意。
如果您需创建项目，仅需在项目列表页面，点击新增项目按钮：
随后在弹框中填写项目的相关信息，点击确定即可：
其中，版本号和项目类型仅用于标注，并无实际用途。
------------------------------------------------------------------------------------------------------------
点击新建接口按钮，进入API编辑页面：
页面上方是接口编辑的三大模块：
基础信息：包含所有API相关的文档信息。eoLinkerAMS提供目前业内最强大、全面的文档系统，一般情况下该文档系统已经可以满足80%以上的API管理需求。
详细说明：eoLinkerAMS提供了富文本以及Markdown双编辑器支持，您可以在此编写详细的API说明信息，并且支持插入图片！可以满足所有的API文档记录需求。
高级Mock：提供自动生成Mock数据的功能，在此选项卡下可以编辑Mock数据的生成规则。eoLinkerAMS全面支持MockJS并且在其之上进行了诸多优化，使得MockJS更加强大和易用。关于Mock的详细使用说明请查看Mock章节。
基础信息中，首先填写API接口的必要信息：
分组：最多支持二级分组，对API进行适当的归类有助于提高管理效率
状态：表示当前API的运行状态【启用、维护、弃用】，仅作为标识方便核查
URL：API的地址，其中包括请求的方式，以及协议和路径，在此建议填写API的相对路径（如/user/login，忽略前面的www.xxx.com根路径），后期通过eoLinkerAMS提供的强大的环境管理功能，统一改变所有API的根路径，相关的教程请看环境管理章节
名称：接口的描述
星标★：注意右侧红色方框部分，您可以为接口标注星标，方便团队间沟通，如表示改接口存在Bug，或者表示需要对接等。
请求头部中，你可以手动输入接口的头部信息，也可以使用导入头部的功能批量导入：
注意，导入的每条头部信息之间通过换行表示结束，如：
Access-Control-Allow-Credentials:true
Access-Control-Allow-Headers:x-requested-with,content-type,Cache-Control,Pragma,Date,x-timestamp
Access-Control-Allow-Methods:POST,GET,OPTIONS
Access-Control-Allow-Origin:https://www.eolinker.com
Connection:keep-alive
Content-Length:0
请求参数部分，eoLinker提供了三种最常用的数据格式（红色部分）：
智能表单[form-data]：支持无限层级结构，并且能对每个参数设定非常详细的示例和值可能性等，同时eoLinker提供了业内唯一的表单转Json方案，可以将表单转为同样格式的Json数据进行发送。
RESTful：支持无限层级结构，并且可以替换接口URL中的相关绑定参数。
源数据[RAW]：所有非表单和Restful类型的参数均可通过源数据进行发送，如Json、XML或者其他自定义的数据格式等。
操作列（蓝色部分）分别是：
参数的更多设置：如参数的值可能性（eoLinker首创功能，全面记录该参数拥有的各种值以及含义）、参数示例等。
拖动排序
删除
返回参数部分和请求参数部分大同小异，不做赘述。
返回示例部分提供了成功以及失败两种结果的记录，同时返回记录也可以作为接口的简易Mock功能，当接口文档保存以后，将会得到两个统一前缀的URL地址，访问该地址可以得到实现记录好的成功结果或者失败结果。
（上图为保存后的返回示例，红色部分的简易Mock的地址，访问即可得到相应的结果，如图中的返回结果为ok）
最后点击页面右上方的保存或者继续添加按钮，即可完成当前接口的创建工作。
熟练之后，创建一个接口文档的时间约为3~5分钟，并且可以连同接口测试一起进行，极大提高开发效率。
------------------------------------------------------------------------------------------------------------
插件获取地址：请点击这里获取插件
eoLinker通过测试插件提供了非常多的独有的测试功能，包括但不限于：
参数构造器：一键对参数进行任意次数的处理
智能表单：根据请求方式自动修改参数发送方式以及拼接参数
在线、跨域、本地测试：不管服务器部署在任何地方，即使是localhost也可以在线进行测试
文件测试：请求参数支持文件格式
支持Restful类型的API测试：自动将参数替换url中的匹配部分
支持Raw源数据类型的API测试：支持json、xml甚至是用户自定义结构的请求参数。
支持查看测试的详细结果，包括头部、返回值以及时间等
支持保存测试历史，并且随时切换到历史的测试记录
支持对返回值进行格式化，并且能够在新窗口中打开
…
对每个功能的具体介绍请查看本章节下的对应教程
插件安装完成之后刷新页面，在接口详情页上方点击测试选项卡，会出现蓝色部分提示“目前正在使用eoLinker测试插件进行测试”。
然后您可以在下方填写测试参数等，点击发送按钮即可得到测试结果！
------------------------------------------------------------------------------------------------------------
插件获取地址：请点击这里获取插件
eoLinker通过测试插件提供了非常多的独有的测试功能，包括但不限于：
参数构造器：一键对参数进行任意次数的处理
智能表单：根据请求方式自动修改参数发送方式以及拼接参数
在线、跨域、本地测试：不管服务器部署在任何地方，即使是localhost也可以在线进行测试
文件测试：请求参数支持文件格式
支持Restful类型的API测试：自动将参数替换url中的匹配部分
支持Raw源数据类型的API测试：支持json、xml甚至是用户自定义结构的请求参数。
支持查看测试的详细结果，包括头部、返回值以及时间等
支持保存测试历史，并且随时切换到历史的测试记录
支持对返回值进行格式化，并且能够在新窗口中打开
…
对每个功能的具体介绍请查看本章节下的对应教程
插件安装完成之后刷新页面，在接口详情页上方点击测试选项卡，会出现蓝色部分提示“目前正在使用eoLinker测试插件进行测试”。
然后您可以在下方填写测试参数等，点击发送按钮即可得到测试结果！
------------------------------------------------------------------------------------------------------------
在项目详情页，点击侧边栏协作管理，在右侧输入想要加入的成员的账号（用户名、手机号、邮箱），点击搜索用户按钮
对想要加入的成员点击添加即可：
当你需要大量邀请成员加入时，可以通过生成邀请链接功能，批量导入成员：
------------------------------------------------------------------------------------------------------------
在项目概况页，点击其他功能下的在线分享项目按钮：
在弹出框中点击启用分享按钮，然后点击复制分享链接，最后点击保存按钮既可。
如果您需要对分享的项目进行加密（需要正确输入密码才能查看），点击启用加密按钮，输入密码，最后点击保存按钮既可。
------------------------------------------------------------------------------------------------------------
今天先到这，欢迎大家提意见和补充内容哈，谢谢各位！
创建项目
在eoLinker可以无限制创建项目，在您注册之后，我们也会为您自动创建一个示例项目，讲解相关的基本操作。如果您需创建项目，仅需在项目列表页面，点击新增项目按钮：
随后在弹框中填写项目的相关信息，点击确定即可：
其中，版本号和项目类型仅用于标注，并无实际用途。
------------------------------------------------------------------------------------------------------------
创建API接口
在项目详情页，点击侧边栏API接口，进入API接口管理页面：点击新建接口按钮，进入API编辑页面：
页面上方是接口编辑的三大模块：
基础信息：包含所有API相关的文档信息。eoLinkerAMS提供目前业内最强大、全面的文档系统，一般情况下该文档系统已经可以满足80%以上的API管理需求。
详细说明：eoLinkerAMS提供了富文本以及Markdown双编辑器支持，您可以在此编写详细的API说明信息，并且支持插入图片！可以满足所有的API文档记录需求。
高级Mock：提供自动生成Mock数据的功能，在此选项卡下可以编辑Mock数据的生成规则。eoLinkerAMS全面支持MockJS并且在其之上进行了诸多优化，使得MockJS更加强大和易用。关于Mock的详细使用说明请查看Mock章节。
基础信息中，首先填写API接口的必要信息：
分组：最多支持二级分组，对API进行适当的归类有助于提高管理效率
状态：表示当前API的运行状态【启用、维护、弃用】，仅作为标识方便核查
URL：API的地址，其中包括请求的方式，以及协议和路径，在此建议填写API的相对路径（如/user/login，忽略前面的www.xxx.com根路径），后期通过eoLinkerAMS提供的强大的环境管理功能，统一改变所有API的根路径，相关的教程请看环境管理章节
名称：接口的描述
星标★：注意右侧红色方框部分，您可以为接口标注星标，方便团队间沟通，如表示改接口存在Bug，或者表示需要对接等。
请求头部中，你可以手动输入接口的头部信息，也可以使用导入头部的功能批量导入：
注意，导入的每条头部信息之间通过换行表示结束，如：
请求参数部分，eoLinker提供了三种最常用的数据格式（红色部分）：
智能表单[form-data]：支持无限层级结构，并且能对每个参数设定非常详细的示例和值可能性等，同时eoLinker提供了业内唯一的表单转Json方案，可以将表单转为同样格式的Json数据进行发送。
RESTful：支持无限层级结构，并且可以替换接口URL中的相关绑定参数。
源数据[RAW]：所有非表单和Restful类型的参数均可通过源数据进行发送，如Json、XML或者其他自定义的数据格式等。
操作列（蓝色部分）分别是：
参数的更多设置：如参数的值可能性（eoLinker首创功能，全面记录该参数拥有的各种值以及含义）、参数示例等。
拖动排序
删除
返回参数部分和请求参数部分大同小异，不做赘述。
返回示例部分提供了成功以及失败两种结果的记录，同时返回记录也可以作为接口的简易Mock功能，当接口文档保存以后，将会得到两个统一前缀的URL地址，访问该地址可以得到实现记录好的成功结果或者失败结果。
（上图为保存后的返回示例，红色部分的简易Mock的地址，访问即可得到相应的结果，如图中的返回结果为ok）
最后点击页面右上方的保存或者继续添加按钮，即可完成当前接口的创建工作。
熟练之后，创建一个接口文档的时间约为3~5分钟，并且可以连同接口测试一起进行，极大提高开发效率。
------------------------------------------------------------------------------------------------------------
基础测试（在线接口测试）
eoLinker提供了非常强大的在线API接口测试功能，在使用之前，请先确保已经安装eoLinker自动化测试增强插件，该插件为您提供了API的在线、跨域、文件以及自动化测试的功能。插件获取地址：
eoLinker通过测试插件提供了非常多的独有的测试功能，包括但不限于：
参数构造器：一键对参数进行任意次数的处理
智能表单：根据请求方式自动修改参数发送方式以及拼接参数
在线、跨域、本地测试：不管服务器部署在任何地方，即使是localhost也可以在线进行测试
文件测试：请求参数支持文件格式
支持Restful类型的API测试：自动将参数替换url中的匹配部分
支持Raw源数据类型的API测试：支持json、xml甚至是用户自定义结构的请求参数。
支持查看测试的详细结果，包括头部、返回值以及时间等
支持保存测试历史，并且随时切换到历史的测试记录
支持对返回值进行格式化，并且能够在新窗口中打开
…
对每个功能的具体介绍请查看本章节下的对应教程
插件安装完成之后刷新页面，在接口详情页上方点击测试选项卡，会出现蓝色部分提示“目前正在使用eoLinker测试插件进行测试”。
然后您可以在下方填写测试参数等，点击发送按钮即可得到测试结果！
------------------------------------------------------------------------------------------------------------
基础测试（在线接口测试）
eoLinker提供了非常强大的在线API接口测试功能，在使用之前，请先确保已经安装eoLinker自动化测试增强插件，该插件为您提供了API的在线、跨域、文件以及自动化测试的功能。插件获取地址：
eoLinker通过测试插件提供了非常多的独有的测试功能，包括但不限于：
参数构造器：一键对参数进行任意次数的处理
智能表单：根据请求方式自动修改参数发送方式以及拼接参数
在线、跨域、本地测试：不管服务器部署在任何地方，即使是localhost也可以在线进行测试
文件测试：请求参数支持文件格式
支持Restful类型的API测试：自动将参数替换url中的匹配部分
支持Raw源数据类型的API测试：支持json、xml甚至是用户自定义结构的请求参数。
支持查看测试的详细结果，包括头部、返回值以及时间等
支持保存测试历史，并且随时切换到历史的测试记录
支持对返回值进行格式化，并且能够在新窗口中打开
…
对每个功能的具体介绍请查看本章节下的对应教程
插件安装完成之后刷新页面，在接口详情页上方点击测试选项卡，会出现蓝色部分提示“目前正在使用eoLinker测试插件进行测试”。
然后您可以在下方填写测试参数等，点击发送按钮即可得到测试结果！
------------------------------------------------------------------------------------------------------------
添加团队成员
eoLinkerAMS中提供了强大的团队协作功能。在项目详情页，点击侧边栏协作管理，在右侧输入想要加入的成员的账号（用户名、手机号、邮箱），点击搜索用户按钮
对想要加入的成员点击添加即可：
当你需要大量邀请成员加入时，可以通过生成邀请链接功能，批量导入成员：
------------------------------------------------------------------------------------------------------------
在线分享项目
在eoLinkerAMS中，您可以一键将项目通过连接分享给其他人。在项目概况页，点击其他功能下的在线分享项目按钮：
在弹出框中点击启用分享按钮，然后点击复制分享链接，最后点击保存按钮既可。
如果您需要对分享的项目进行加密（需要正确输入密码才能查看），点击启用加密按钮，输入密码，最后点击保存按钮既可。
------------------------------------------------------------------------------------------------------------
今天先到这，欢迎大家提意见和补充内容哈，谢谢各位！
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 
相关文章推荐
- eoLinker-AMS接口管理系统 环境管理教程
- eoLinker-AMS接口管理系统 项目管理教程
- eoLinker-AMS 接口管理系统
- eoLinker-AMS接口管理系统 API基础测试教程
- eoLinker-AMS接口管理系统 API文档管理教程
- eoLinker-AMS接口管理系统 状态码管理教程
- eoLinker-AMS接口管理系统 代码注入教程
- eoLinker-AMS接口管理系统 Mock API教程
- eoLinker-AMS接口管理系统 项目文档管理教程
- eoLinker-AMS接口管理系统 API自动化测试教程
- eoLinker-AMS接口管理系统 协作管理教程
- 开源免费接口管理平台eoLinker AMS开源版 V3.2.0更新，增加批量导出导入接口功能！
- Linux快速入门03-系统管理
- 开源接口管理平台 eoLinker AMS开源版 V3.2.1更新，Mock增加允许新请求头！
- OpenStack云计算快速入门之三：OpenStack镜像管理
- Redis快速入门：Key-Value存储系统简介
- RDIFramework.NET ━ .NET快速信息化系统开发框架- 4.8 模块（菜单）管理
- 信息管理系统的快速开发
- 【银行管理系统】先实现一个普通窗口为普通客户服务，快速Vip类比
- 入门作—学生信息管理系统