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

最新推荐文章于 2018-10-27 17:19:00 发布

chuanquanzhen8879

最新推荐文章于 2018-10-27 17:19:00 发布

阅读量395

点赞数

文章标签： json 测试 markdown

原文链接：https://my.oschina.net/ProLinker/blog/1605632

版权

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

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

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

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

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

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

点击 新建接口 按钮，进入 API编辑页面 ：

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

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

基础信息中，首先填写API接口的必要信息：

分组：最多支持二级分组，对API进行适当的归类有助于提高管理效率
状态：表示当前API的运行状态【启用、维护、弃用】，仅作为标识方便核查
URL：API的地址，其中包括请求的方式，以及协议和路径，在此建议填写API的相对路径（如/user/login，忽略前面的www.xxx.com根路径），后期通过eoLinker AMS提供的强大的 环境管理 功能，统一改变所有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或者其他自定义的数据格式等。

操作列（蓝色部分）分别是：