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:

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ファイルを選択して、インポートしました。
Lambdaだけ再選択して実行権限を付与しました。
あとは、そのままテストして正常動作を確認しました。

最後までお読みいただきましてありがとうございました！

【PR】「AWS認定試験対策 AWS クラウドプラクティショナー」という本を書きました。

【PR】「AWSではじめるLinux入門ガイド」という本を書きました。

@yamamanx

開発ベンダー5年、ユーザ企業システム部門通算9年、ITインストラクター3年目でプロトタイプビルダーもやりだしたSoftware Engineerです。
質問はコメントかSNSなどからお気軽にどうぞ。
出来る限りなるべく答えます。

このブログの内容/発言の一切は個人の見解であり、所属する組織とは関係ありません。
このブログは経験したことなどの共有を目的としており、手順や結果などを保証するものではありません。
ご参考にされる際は、読者様自身のご判断にてご対応をお願いいたします。

また、勉強会やイベントのレポートは自分が気になったことをメモしたり、聞いて思ったことを書いていますので、登壇者の意見や発表内容ではありません。

- AWS apigateway, AWS

: ALBの重み付けルーティングでカナリアリリースをしてみました

当ブログのAMIの更新と、ALBターゲットグループのヘルスチェックを変更したかっ …

: EC2にSystems MangerからCloudWatchエージェントをインストール

CloudWatchエージェント EC2の標準メトリクスでは収集できないメモリの …

: 試したい事があるのでAWS でとりあえずAmazon Linuxのサーバを作る

1年間の無料キャンペーン期間中に検証するとある勉強会でせっかくAWSのアカウン …

: Route53でドメインを新規取得してDNSレコードを設定する

Elastic IPをAWSで発行しているのですから、DNSの設定も同じようにマ …

: AWS EC2 Amazon Linux にEC-CUBE3をnginx+MySql環境へインストール(手順検証中)

EC2インスタンスを作成する少し古い記事で恐縮ですが試したい事があるのでAWS …

: Amazon CloudSearchからAmazon Elasticsearch Serviceへ変えました

全文検索をする必要がありまして、本当はCloudSearchを使い続けたいのです …

: EC2 セッションマネージャにEC2インスタンスの一覧から接続できるようになりました

EC2に接続する時に、どうしてもSSHクライアントから接続しないといけない場合を …

: API Gateway Lambdaプロキシ統合で渡されるリクエストを確認しました

API Gatewayの統合リクエストでLambdaを指定するときにプロキシ統合 …

: AWS Certificate Manager(ACM)メール検証をDNS検証の証明書に差し替えました

ブログの証明書このブログの証明書の有効期限があと1週間です。証明書はAWS …

: AWS Lambda(Python3.7)でPandocを実行する

昨日まで(AWS Batch) 昨日までは、Pandocを実行して、S3バケット …

PREV: Bear マークダウンエディタを気がつけば3年ぐらい使ってます
NEXT: AWS Lambda Layersのアーカイブファイルをダウンロードする

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

ad

ad

関連記事