Amazon API 网关提供 Swagger 定义导入支持

  • Kent Weare
  • 谢丽

2016 年 4 月 13 日

话题:AWS架构

2016 年 4 月 5 日,Amazon宣布更新其 API 管理服务 Amazon API 网关。经过此次更新,Amazon API 网关现在支持直接导入 Swagger 2.0 的 API 定义了。

Swagger 是一种规范,允许开发人员使用一种通用描述语言表示 REST API。开发人员可以使用 swagger 编辑器设计 REST API,作为这种体验的一部分,文档和元数据也会通过工具显示出来。使用 Swagger 定义可以创建模拟测试客户端和面向多种语言的 SDK,包括 Java、JavaScript、Ruby、PHP 和 C#,这可以为想要使用你的 API 的组织缩短开发周期。

自 Amazon API 网关服务推出以来,Swagger 就是它支持的一种 API 规范。但是,开发人员之前需要使用 Swagger 导入工具将 Swagger 定义导入到 API 网关。Swagger 导入工具可以从GitHub上下载,它提供了一种命令行工具体验:

图片来源:http://swagger.io/getting-started-with-the-amazon-swagger-importer/

今后,开发人员可以使用 AWS 管理控制台、命令行接口(CLI)或 SDK。开发人员可以在 AWS 管理控制台上进行如下操作:

  • 新建一个 API;
  • 克隆已有的 API;
  • 从 Swagger 导入;
  • 查看示例 API。

图片来源:http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-from-example.html

到今年 1 月 1 日,Swagger 规范已经捐献给Open API Initiative(OAI)。OAI 意在将对标准化 REST API 描述感兴趣的组织团结在一起。OAI 在 Linux 基金会下以一个开放的治理结构运营,其成员包含许多行业领导者,包括 Google、Apigee、Atlassian、IBM、Intuit、Microsoft、PayPal 等等。

Swagger 并不是 Amazon API 网关唯一支持的一种 API 规范。该服务还支持一种与其存在竞争关系的规范RAML。在本文写作的时候,Amazon 已经指出,“使用 RAML 定义的客户当前应该继续使用 aws-apigateway-importer。”RAML 是由Mulesoft领导的一个开放的工作组,获得了包括 Cisco(Mulesoft 投资人之一)、VMWare 和 Akana 在内的其他成员的支持。

查看英文原文:Amazon API Gateway Now Supports Swagger Definition Import

立即免费注册 AWS 账号,获得 12 个月免费套餐:点击注册

有云计算问题?立刻联系 AWS 云计算专家:立即联系

AWS架构