【超簡単】Swagger(yaml)にAWS_IAMを設定する方法


Swagger(yamlファイル)にAWS_IAMを設定する方法が知りたいんだよね…
こんな疑問にお答えします。
この記事で分かること
- 本記事の執筆者
本記事を書いている僕はエンジニア歴7年です。
AWSは業務歴2年半なので、かなり有益な情報を発信できるかと思います。
結論、Swagger(yamlファイル)にAWS_IAMを設定するのは超簡単です。
具体的なファイル内容も載せているので安心してくださいね。


本記事を読んでもらえれば、Swagger(yaml)にAWS_IAMを設定する方法が理解できるので、早速見ていきましょう。



すぐ読み終わるので、是非最後まで読んでみてください!
目次
Swagger(yaml)にAWS_IAMを設定する方法
早速ですが、Swagger(yaml)にAWS_IAMを設定する方法を解説します。



今回は、API Gatewayの定義ファイルを元に解説します。
---
swagger: "2.0"
info:
version: "1.0"
title: "hello-world"
host: "*****.execute-api.ap-northeast-1.amazonaws.com"
basePath: "/api"
schemes:
- "https"
paths:
/authorizer:
get:
produces:
- "application/json"
responses:
"200":
description: "200 response"
schema:
$ref: "#/definitions/Empty"
security:
- sigv4: []
x-amazon-apigateway-integration:
uri: "arn:aws:apigateway:ap-northeast-1:lambda:path/2015-03-31/functions/arn:aws:lambda:ap-northeast-1:*****:function:chalice-dev/invocations"
httpMethod: "POST"
responses:
default:
statusCode: "200"
passthroughBehavior: "when_no_match"
contentHandling: "CONVERT_TO_TEXT"
type: "aws_proxy"
securityDefinitions:
sigv4:
type: "apiKey"
name: "Authorization"
in: "header"
x-amazon-apigateway-authtype: "awsSigv4"
definitions:
Empty:
type: "object"
title: "Empty Schema"
x-amazon-apigateway-binary-media-types:
- "application/octet-stream"
- "application/x-tar"
- "application/zip"
- "audio/basic"
- "audio/ogg"
- "audio/mp4"
- "audio/mpeg"
- "audio/wav"
- "audio/webm"
- "image/png"
- "image/jpg"
- "image/jpeg"
- "image/gif"
- "video/ogg"
- "video/mpeg"
- "video/webm"
sigv4を設定すれば完了です。



超簡単でしたね。
よくある質問|Swagger(yaml)にAWS_IAMを設定する方法
- Swagger(yaml)でAWS_IAMを設定するにはどうすればよいですか?
-
sigv4の設定を追記すればOKです。
まとめ|AWS_IAMはsigv4を設定すればOK
今回は、Swagger(yaml)にAWS_IAMを設定する方法について解説しました。
以下が本記事のまとめになります。
まとめ
- Swagger(yaml)でAWS_IAMを設定するにはsigv4を追記する。
この記事があなたのお役に立てば幸いです。
サイト内には、他にも初心者向けの記事を多く投稿していますので良ければ参考にしてみてください。
最後までお読みいただきありがとうございました!
あわせて読みたい




【AWS Chalice】API GatewayにIAM認証を付ける方法
AWS ChaliceでAPI GatewayにIAM認証を付けたいんだけど、やり方が分からないんだよね… こんな疑問にお答えします。 この記事で分かること ChaliceでAPI GatewayにIAM…
あわせて読みたい




【Python】ID PoolでAPI GatewayのIAM認証を突破する方法
PythonでAPI GatewayのIAM認証を突破する方法が知りたいんだよね… こんな疑問にお答えします。 この記事で分かること ID PoolでAPI GatewayのIAM認証を突破する方法 …
あわせて読みたい




API GatewayのゲートウェイレスポンスをCloudFormationで設定する方法
API GatewayのゲートウェイレスポンスをCloudFormationで設定したいんだけど、やり方がわからないんだよね… こんな疑問にお答えします。 この記事で分かること ゲート…