导入导出API定义

更新时间: 2024-12-18 13:24:52

本篇文档介绍API网关导入、导出标准OAS定义,及导入API网关的扩展Swagger定义。帮助您高效、安全和自动化地管理和维护API服务。

导入标准OAS定义

API网关支持导入OAS 2.0和OAS3.0格式的API定义,也支持导入扩展后的OAS定义,您可以快速将现有系统的API接入网关。使用现有API定义文件,无需修改就可以在API网关中配置并管理这些API。详细内容包括:

  • 标准OAS2.0格式与API网关的对应。

  • 标准OAS3.0格式与API网关的对应。

  • 导入具有API网关扩展字段的OAS格式定义。

导出标准OAS定义

API网关支持导出标准OAS定义,能将已有API服务的定义从API网关中以OAS 2.0或OAS 3.0格式导出。您可以实现跨账号,跨地域间甚至跨平台的数据迁移,实现灵活的API管理和部署。详细内容包括:

  • 导出标准OAS格式的API定义。

    导出API定义支持以分组为单位进行API导出,也支持通过批量勾选API进行导出。

导入API网关的扩展Swagger定义

API网关支持通过导入Swagger 2.0的文件来创建API。您可以参考API接口ImportSwagger,或在控制台上进行操作。详细内容包括:

  • Swagger扩展:Swagger扩展主要是对于swagger原生Operation Object进行扩展,增加认证、参数映射以及后端服务等扩展。

  • 兼容性说明:Swagger参数类型与原有API网关类型的差异性对照。

  • Swagger示例:基于API网关的Swagger扩展示例。

  • 特别说明:swagger导入功能特别说明。

上一篇: 配置后端服务Host(域名头) 下一篇: 导入标准OAS定义