阿里云API网关导入API步骤

导入API
 
Swagger是一种基于OpenAPI规范的开源工具,用于设计和描述后端服务的API。目前阿里云API网关支持导入Swagger2.0标准规范的文件以快速创建API。
 
前提条件
 
获取待导入的Swagger文件,Swagger的相关内容可参考Swagger使用说明。
您需要在API定义中补全API网关的Swagger的扩展定义,可参考Swagger扩展。
用户可创建的API分组数量及分组下可创建的API数量需要大于Swagger文件里包含的API分组数量及API数量。

操作步骤
 
1.  登录API网关管理控制台。
 
2.  单击左侧导航栏开放API > API管理,进入API管理页面。
 
3.  选择目标地域。
 
4.  单击页面右上角的导入,进入导入页面。
 
5.  根据以下信息,导入Swagger文件:
 
配置项说明
 
导入方式
导入Swagger到分组的方式,目前支持:
导入到新的分组:系统会自动根据Swagger文件创建新的分组,并将由导入Swagger文件创建的API归属到新分组。
导入到已有分组:系统不会删除已有分组下的API,仅新增由Swagger文件创建的API到已有分组。

API分组
在导入方式为导入到已有分组时,需要设置此项。
 
选择导入到的目标分组。
是否覆盖
 
在导入方式为导入到已有分组时,需要设置此项。
 
打开覆盖开关,若待导入Swagger文件中的Path和HTTP Method与已有分组中的API重复,则由导入Swagger文件创建的API覆盖已有API。
 
导入Swagger
 
单击上传Swagger,选择目标Swagger文件并上传。
 
预检
 
单击预检,对待导入的Swagger文件进行检查。
 
如果导入的Swagger文件的编码不是utf-8,可能会出现乱码。
 
返回结果
 
显示预检的结果。包括:
 
API名称、PATH、分组名称、预检状态以及预检失败原因。
 
6.  单击导入。
 
7.  单击完成。
 
执行结果
 
在API管理页面的目标地域下,可以看到目标API已成功创建。