README.ja.md

English / 日本語

サンプルのCDKスタック

@codemonger-io/cdk-rest-api-with-specのサンプルCDKスタックです。 このCDKスタックは以下のコマンドで初期化しました。

cdk init --language typescript

CDKのバージョンは2です。

事前準備

Node.jsのインストール

Node.jsをインストールしてください。 v18.xで大丈夫なはずです。

CDKスタックをデプロイする

AWS_PROFILEを設定する

例

export AWS_PROFILE=kikuo-jp

ツールキットスタック名を設定する

例

TOOLKIT_STACK_NAME=api-with-spec-example-toolkit

Synthesizer Qualifierを設定する

例

TOOLKIT_QUALIFIER=apispc2022

ツールキットスタックのBootstrap

pnpm cdk bootstrap --toolkit-stack-name $TOOLKIT_STACK_NAME --qualifier $TOOLKIT_QUALIFIER

CloudFormationテンプレートを合成する

pnpm cdk synth -c "@aws-cdk/core:bootstrapQualifier=$TOOLKIT_QUALIFIER"

OpenAPI定義を含むopenapi/openapi.jsonファイルが作成または更新されます。

CDKスタックをデプロイする

pnpm cdk deploy --toolkit-stack-name $TOOLKIT_STACK_NAME -c "@aws-cdk/core:bootstrapQualifier=$TOOLKIT_QUALIFIER"

api-with-spec-exampleというCloudFormationスタックが作成または更新されます。

OpenAPI定義を含むopenapi/openapi.jsonファイルも作成または更新されます。