Swagger是基于OpenAPI规范构建的开源工具,可以帮助您设计、构建、记录以及使用Rest API。API网关支持导入Swagger 2.0定义的API到已有的API分组或新的API分组。
导入API支持单个API导入和批量API导入,主要取决于Swagger文件中包含的API数量。
已获取待导入API的Swagger文件,导入前您需要在API定义中补全API网关的《开发指南》的“扩展定义”章节。
API分组和API的配额满足需求。
步骤 1 登录管理控制台。
步骤 2 单击管理控制台左上角,然后单击“API网关 APIG”。
步骤 3 在左侧导航单击“专享版”,进入专享版实例列表页,单击“查看控制台”,进入API开发与调用管理页面。
步骤 4 单击“开放API > API管理”,进入到API管理信息页面。
步骤 5 单击“导入API”,进入“导入API”界面。
步骤 6 选择如表5-15所示参数。
表5-15导入API
参数名称 | 说明 |
---|---|
导入方式 | 导入方式包含以下2种:
|
API分组 | 仅在选择“导入到已有分组”时,需要选择API分组。 |
是否覆盖 | 勾选后,当导入的API名称与已有的API名称冲突时,导入的API会覆盖已有的API。 仅在选择“导入到已有分组”时,需要选择是否覆盖。 |
扩展覆盖 | 当导入API扩展信息(ACL,流控)与已有的API扩展信息冲突时,会覆盖已有API扩展信息。 |
步骤 7 单击“导入参数”下方的“文件”,选择待导入的API文件。
支持yaml和json两种文件格式的API导入,界面可预览待导入API内容。
步骤 8 (可选)修改待导入API的全局配置。
您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。
步骤 9 单击“快速上线”,完成API导入。
导入的API不会自动发布到环境,需要您手动发布。
将导入成功的API 发布API中,以便API调用者调用。