README.ja.md

English / 日本語

CDK CORSユーティリティ

AWS Cloud Development Kit (CDK)でAmazon API Gateway (API Gateway)にCORS設定を行うユーティリティを提供します。

誰のためのライブラリ?

CDKでAPI Gatewayに繰り返しCORS設定をするのが面倒でしょうがないあなたにはこのライブラリが役に立つかもしれません。

背景

API GatewayでREST APIを記述するとき、いつもCORSを扱うためのユーティリティ関数をいくつか書いています。 これらの関数はとてもシンプルですが、新しいプロジェクトを始めるたびにもう毎回準備したくありません。

インストール方法

このレポジトリをNodeの依存関係に追加してください。

npm install https://github.com/codemonger-io/cdk-cors-utils.git#v0.3.0

インストールしたモジュールはcdk2-cors-utilsとして以下のように利用できます。

import { makeIntegrationResponsesAllowCors } from 'cdk2-cors-utils';

このライブラリはCDK v2.x用に設計されており、CDK v1.xでは使えません。

API

api-docs/markdown/index.mdを参照ください(英語版のみ)。

サンプル

TBD

開発

TypeScriptファイルをトランスパイルする

buildスクリプトはsrcフォルダ内のTypeScriptファイルをトランスパイルします。

npm run build

トランスパイルされたJavaScript(*.js)ファイルと型宣言(*.d.ts)ファイルがdistフォルダに作られます。

APIドキュメントを生成する

docスクリプトはAPIドキュメントを生成します。

npm run doc

api-docs/markdownフォルダ内のMarkdownファイルが更新されます。 ドキュメントはAPI ExtractorとAPI Documenterで生成しています。