开发者门户指南

贡献服务-分组

创建分组

分组是接口服务的管理单元，先创建分组，然后在分组下创建接口。

在我的服务-分组管理，点击【创建分组】，填写基本信息。

绑定服务地址

点击分组名称进入分组详情，操作绑定服务地址。

添加分组成员

开发者主账号可在分组下添加分组成员，协助进行接口新增和维护。

贡献服务-接口

新增接口

创建 API 即录入 API 的定义，需要录入 API 的基本信息、定义对外请求、定义后端服务、定义返回结果，并申请发布上线供平台用户使用。

1）基本信息包括 所属分组、 API 名称、是否租户鉴权。

• 所属分组：新增接口时，需要先创建分组
• API名称：API 名称需具有唯一性
• 租户鉴权：若需租户鉴权，则还需填写参数位置和字段
• 描述：API功能描述

2）定义对外请求包括 请求方法、请求路径、请求示例和参数定义。

• 请求方法： PUT、GET、POST、DELETE、PATCH、或 HEAD
• 请求路径：接口的请求路径
• 请求示例：提供示例供开发者参考
• 参数定义：定义您 API 的请求入参，包含参数名、参数位置、类型、是否必填、默认值、描述、示例等信息

3）定义后端服务包括 后端路径、后端超时设置和参数确认请求示例和参数定义。

4）定义返回结果包括 成功返回示例、失败返回示例以及返回参数定义。

新增接口完成后，可在接口详情查看接口定义，以及该接口授权了哪些应用。

接口发布与下线

当您完成API的创建后，您可以将 API 发布到测试或者线上。也可以将测试或者线上的 API 下线。

当您要发布某个 API 时，如果该 API 在测试或者线上已经有版本在运行，您的此次发布将使测试或者线上的该 API 被覆盖，实时生效。