导入API 概述 网关支持导入OAS2.0和OAS3.0格式的API定义,帮助用户快速将现有系统的API接入网关。API网关既支持标准OAS格式的API定义的导入、也支持OAS定义扩展后的API定义导入。 导入标准OAS格式的API定义 导入API的流程主要包括: 选择基本信息(必填)与全局配置(选填). 文本填写或文件导入OAS 2.0或OAS 3.0格式的API定义. 进行预检并根据检查结果进行调整. 执行导入,成功导入后会生成对应的API和分组模型. 对应控制台操作为: 1, 进入API托管>API管理菜单页. 2, 在API列表页点击导入Swagger 按钮,进入API导入配置页面. a. 基本信息,必填 参数 描述 导入分组 提供分组下拉列表,当API定义版本为OAS2时,用户填写的basePath需与所选分组的basePath一致,否则会预检失败 是否覆盖 当选择覆盖时,如果遇到请求路径和http请求冲突时,自动覆盖原有API;当不选择覆盖时,如果遇到请求路径和http请求冲突时,返回错误提示API已经存在 API定义版本 可选OAS2.0和OAS3.0。会校验所填写的API定义与所选版本是否适配 后端服务 如果在OAS定义中未填写"xctyunapigatewaybackend"扩展字段值,则以该服务作为后端服务;否则优先使用OAS中定义的服务信息 b. 全局配置,选填.主要是对入参请求模式,防止重放攻击进行API全局设置。如果用户OAS定义中通过扩展字段填写了该配置信息,则优先使用用户配置. c. API定义,确定计划导入的OAS定义内容,支持文本填入yaml或json格式的API定义内容,也支持上传本地API定义文件。 3, 单击预检按钮,系统将会对计划导入的内容进行检查,检测出OAS定义中的API定义和模型定义,以及告警和错误信息。 4, 预检过程中没有错误信息和警告信息(或者忽略警告信息之后),可执行导入。单击导入Swagger按钮,系统真正开始导入API,导入API需要一定时间,导入过程请勿关闭浏览器。 5, 待系统执行完毕后,可查看到API导入结果。