API Gateway 作成済REST APIの定義をSwaggerの形式でエクスポート

2020/02/16 2020/05/18

SAMで似たようなAPIを作りたくて、エクスポートしました。

Swaggerは、RESTful APIを構築するためのオープンソースフレームワークで、Swaggerを使うことで、API Gatewayでも定義をエクスポート、インポートできます。
非常に便利です。

マネジメントコンソールのAPI Gatewayで作成済のAPIで対象のステージを選択しました。

[エクスポート]タブで[次の形式でエクスポート]でSwaggerを選択して、[Swagger + API Gateway 拡張の形式でエクスポート]でYAMLを選択しました。

これで完了です。
簡単ですね。

「+ API Gateway 拡張の形式」を選択することで、x-amazon-apigateway-integrationなど API Gatewayの情報も出力されます。

インポート用に以下を調整しました。

versionを1.0.0にしました。
host行を削除しました。
既存のAPIが更新されると困るので。titleを変更しました。

swagger: "2.0"
info:
  version: "1.0.0"
  title: "import_test"
basePath: "/esv2"
schemes:
- "https"
paths:
  /course:
    get:
      consumes:
      - "application/json"
      produces:
      - "application/json"
      parameters:
      - name: "query"
        in: "query"
        required: false
        type: "string"
      responses:
        200:
          description: "200 response"
          schema:
            $ref: "#/definitions/Empty"
          headers:
            Access-Control-Allow-Origin:
              type: "string"
      x-amazon-apigateway-integration:
        uri: "arn:aws:apigateway:ap-northeast-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ap-northeast-1:123456789012:function:course_search_es/invocations"
        responses:
          default:
            statusCode: "200"
            responseParameters:
              method.response.header.Access-Control-Allow-Origin: "'*'"
        requestTemplates:
          application/json: "{\n    \"query\": \"$input.params('query')\"\n}"
        passthroughBehavior: "when_no_templates"
        httpMethod: "POST"
        contentHandling: "CONVERT_TO_TEXT"
        type: "aws"
    options:
      consumes:
      - "application/json"
      produces:
      - "application/json"
      responses:
        200:
          description: "200 response"
          schema:
            $ref: "#/definitions/Empty"
          headers:
            Access-Control-Allow-Origin:
              type: "string"
            Access-Control-Allow-Methods:
              type: "string"
            Access-Control-Allow-Headers:
              type: "string"
      x-amazon-apigateway-integration:
        responses:
          default:
            statusCode: "200"
            responseParameters:
              method.response.header.Access-Control-Allow-Methods: "'GET,OPTIONS'"
              method.response.header.Access-Control-Allow-Headers: "'Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'"
              method.response.header.Access-Control-Allow-Origin: "'*'"
        requestTemplates:
          application/json: "{\"statusCode\": 200}"
        passthroughBehavior: "when_no_match"
        type: "mock"
definitions:
  Empty:
    type: "object"
    title: "Empty Schema"

swagger: "2.0"

info:

version: "1.0.0"

title: "import_test"

basePath: "/esv2"

schemes:

- "https"

paths:

/course:

get:

consumes:

- "application/json"

produces:

- "application/json"

parameters:

- name: "query"

in: "query"

required: false

type: "string"

responses:

200:

description: "200 response"

schema:

$ref: "#/definitions/Empty"

headers:

Access-Control-Allow-Origin:

type: "string"

x-amazon-apigateway-integration:

uri: "arn:aws:apigateway:ap-northeast-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ap-northeast-1:123456789012:function:course_search_es/invocations"

responses:

default:

statusCode: "200"

responseParameters:

method.response.header.Access-Control-Allow-Origin: "'*'"

requestTemplates:

application/json: "{\n \"query\": \"$input.params('query')\"\n}"

passthroughBehavior: "when_no_templates"

httpMethod: "POST"

contentHandling: "CONVERT_TO_TEXT"

type: "aws"

options: