API基本信息

进入 API文档 页面，点击 新建API 按钮，进入到 API编辑 页面。

设置API分组

最多支持三级分组，对API进行适当的归类有助于提高管理效率。

设置API URL以及API名称

如果您有多个项目环境，不同的项目环境拥有不同的请求URL前缀，那么URL仅需要填写API的路径即可（如/user/login），切换不同的URL前缀可以使用eoLinker AMS中的环境管理功能。相关教程请前往 API开发管理 > 公共资源管理 > 环境管理 一节。

设置API状态

在eoLinker AMS中，API拥有以下的几种状态：

状态	描述
启用	当前API正常使用
维护	当前API正在维护，不建议使用
弃用	当前API已经停用，不建议使用
待定	当前API尚未开发，需求待定
开发	当前API正在开发
测试	当前API正在测试
对接	当前API正在对接调试
BUG	当前API出现BUG，建议尽快修复

请求信息

在API文档中，您可以记录Header、Request Body、REST Params、Query/GET Params、鉴权等信息。

设置Header

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

设置Request Body

Body请求参数提供了两种类型：Form-data或者Raw。您可以您可以手动输入请求参数或者使用 导入JSON / 导入XML 功能来批量导入请求参数。

同时，Form-data支持记录无限层级结构的请求参数，参数层级通过 “>>” 表示并且能对每个参数设定非常详细的示例和值可能性等：

设置REST Params

在eoLinker AMS中，REST参数在URL中使用 {param_name} 表示，如 /user/login/{user_name}/{user_type}，该API拥有REST参数user_name和user_type。

注意，您只需要在URL中使用{}将REST参数括起来，下方的表格中不需要使用{}。

返回参数

您可以您可以手动输入请求参数或者使用 导入JSON / 导入XML 功能来批量导入请求参数。

返回示例

您可以记录API请求成功或失败的示例，eoLinker AMS提供了API来获取编写好的API返回示例，可以用于前端开发人员测试API。

保存API文档之后，通过返回示例API即可获得事先编写好的返回示例：

API详细文档

当API文档无法详细地记录下您的API信息时，您可以通过使用Markdown或者富文本的方式来编写需要补充的信息：

Mock API

如需了解如何设置Mock API的生成规则，请移步至 API开发管理 > Mock API > 设置MockAPI 一节中查看。