通过控制台创建REST API
登录云原生API网关控制台。先在顶部菜单栏选择 "地域" ,然后在左侧导航栏选择 "API"。
单击 "创建API" 。
单击 "REST API" 卡片中的 "创建" ,在 "新增API(REST)" 弹出框中配置相关参数,单击 "确定" 。
| 配置项 | 说明 |
|---|---|
| API名称 | 自定义创建的API名称。 注意 API名称需要保证唯一。 |
| API协议 | API允许接受的HTTP协议。 |
| Base Path | API的基本路径,访问具体接口时,完整路径为 http(s)://{域名}/{BasePath}/{接口Path}。 |
| 版本管理 | 是否启用API版本管理能力,不同版本的API拥有相同的API名称,但参数定义、接口配置可以不同,编辑当前API版本的参数定义、接口配置和策略,不会影响其他版本。不同版本的API可以视为独立的API,访问时需要指定版本标识符。 开启版本管理功能后,需要配置使用方式。 |
| 使用方式 | 支持Path、Query、Header三种方式。
|
| 描述 | 填写API的相关描述 |
通过导入OpenAPI文件创建REST API
首先按照上文中通过控制台创建REST API步骤创建一个REST API。
单击刚才新建成功的 "API名称" ,进入 API详情页面,单击右上角的 "更多操作" ,单击 "导入"。
在弹出框中单击 "从文件导入",选择待导入的OpenAPI文件,然后单击 "预检并创建"。
选择 "合并逻辑",各选项说明如下:
选项 说明 智能合并 将在已存在的API基础之上,创建新增的接口,更新重复的接口,但不删除仅在原API中存在的接口。 仅导入新增接口 将在已存在的API基础之上,仅创建新增的接口,对重复或原有的接口不做处理。 覆盖当前API 基于当前导入的文件重新创建API,完全覆盖已有API。 如果预检结果为失败,需要您修改配置文件并重复上述步骤。如果预检结果为成功,可以单击 "创建API" 根据选择的合并逻辑进行API导入 。
添加接口
在REST API中,单击 "添加接口" 。
在 "创建接口" 弹出框中配置相关参数,单击 "保存" 。
配置项 说明 接口名称 自定义创建的接口名称,在API下需要唯一。 接口Path 接口的具体路径。 方法 接口的请求方法。接口的路径+接口的方法,需要在API下唯一。 描述 接口的描述信息。 请求定义 支持定义 "Header" 、"Query"、"Parameter Path" 参数以及 "Body" 参数。
其中Path参数支持在接口Path中按照如下方式进行变量定义:
/books/:bookId
说明
请求定义仅用于文档展示和生成,不对运行时进行校验。
响应定义 定义不同响应码的数据结构。
说明
响应码定义仅用于生成文档,不对运行时进行校验。
Mock Mock配置仅在API发布Mock场景下生效。