第二步：注册API

成功创建项目之后，您会看到项目的总览面板。这个面板上有4个标签页：

• 总览：显示当前项目的主要信息，并可以实现快速上/下线操作
• 开发：注册API
• 调试：在部署、上线之前对已注册的API进行调试
• 监控：展示当前项目下已部署上线的API运行情况

点击【开发】标签页，之后就可以开始注册自己的API了。

开发页面分为四个区域：

区域名称	功能
API&路由配置区	在这里注册路由或者API
后端配置区	在这里可以注册API所对应的后端
插件配置区	在这里可以为路由或API添加热插拔的插件。实现对路由或API的精细管理
参数配置区	这里对当前选中的项目进行详细的参数配置

路由：您可以把路由理解为一个端点, 路由下所有API的访问会经过该端点。您甚至可以在这个端点上设置一些流量或访问限制策略从而实现对路由下的API进行批量控制的目的。

好，下面让我们开始注册第一个API

API需要注册在一个路由下,并且每个路由需要对应一个实际提供服务 后端 。因为我们通过模板快速创建了项目，所以此刻我们已经有了 默认路由 和 默认后端 。

接下来我们要做的就是在默认路由下添加一个API了。 互联网上有一个免费用来模拟各种API请求/响应状态的项目https://reqres.in。(我们demo中的API大多会取自这里)。这次，我们挑选一个简单的 GET API 作为例子。这个请求的原始访问地址为:

https://reqres.in/api/users/2

现在，我们尝试将它注册到我们的平台上来。

字段说明：

• 名称：API的名称，用于在项目中区分API，API发布到门户后会显示在门户张红。

• 子路径：API的部分调用路径，由所属路由路径和API路径组成。

  • 我们在创建项目的时候将默认路由路径设置为 /api/。所以API路径中会自动显示其路由部分的路径。但路由路径不会拼接到后端地址进行代理。
  • API路径部分将拼接在所对应的后端地址后（https://reqres.in/ + api/users/{id}），用于网关代理使用。

• 请求方法：API调用方法，通常和注册的原API一致。也可以使用【请求转换插件】进行更改。

• 后端：API对应的后端，可以在路由配置页面进行变更。

完成添加之后，在参数配置区会看到关于这个API更丰富和详细的配置内容，以下针对重点功能进行介绍：

1. API Mocking

   可以通过Mock设置API的静态响应内容，方便于当原始API尚不可用时，提前通过网关发布的Mock API进行联调。

2. API 状态

   可以通过切换API状态，来暂时停用某API，或将某API标记为过时。

   

3. API参数设置

   API参数设置主要用于门户中API文档的渲染，以及部分和API参数有关的插件（比如【参数验证插件】）使用。

   

   首先是定义参数和描述响应结果。

   在定义参数的时候您会看到一个细节，由于在添加API时，您在路径中输入了路径参数/api/users/{id}，所以这里会自动识别出您有一个路径参数，参数名为 id，且为必填项。您还可以在这里添加 query 和 header 位置的更多参数。

   在响应结果部分，您可以定义响应的 Content Type 和正常、失败的返回结果示例及JSON Schema模型。

   从v3.0_08000版本开始，系统开始支持图形化配置请求方向的Body参数。

   

   最后一部分是定义定义错误码信息。

   在错误码定义的地方添加错误之后可以在下方的错误返回结果定义中添加针对该错误码的示例：

   为了考虑向之前版本的兼容。原响应结果基础定义中的 失败返回结果示例 仍然保留。如果没有需要您可以不填写这个单元的信息。

到这里，我们已经完成了第一个API的注册。在下一步中我们将会了解如何调试注册后的API。

相关功能

复制路由

在路由的操作选项中，用户可以通过复制路由快速创建一个路由以及该路由下API的副本。目前暂不支持对 D2A、编排和SOAP Service类 路由的复制。

API移动

在路由的操作选项中，用户可将A2A类型的API在路由之间移动，需要注意移动后API的后端将会变为目标路由的后端。