概要
Simple API Gatewayというコマンドラインツールを作って公開しました。
API Gatewayの設定からデプロイまでを対話形式のコマンドで行ってくれるツールです。
解決する課題
API GatewayはAPIの管理作成をやってくれるAWSのサービスですが、マネジメントコンソールやaws-cliでの設定は設定項目や手順がそれなりに多く大変です。
Simple API Gatewayはコマンドラインでの対話形式で設定を手引してくれます。結果、API Gatewayの設定の煩雑さから開放されます。
特徴
ざっとあげると以下の通りだと思います
メリット
- コマンドラインの対話式でAPI Gatewayの設定が可能なため、迷わない。手引の通りにやれば良い
- POSTやGETで送られてきた値をよろしくバックエンドのLambdaに渡すように自動でマッピングテンプレートを構成しているため、マッピングテンプレートの設定を考えなくて良い
- CORSにも対応している
デメリット
- Lambda以外の統合タイプが使えない
- LAmbdaの返り値に応じてヘッダを変えたりといった、複雑な設定は対応できない
インストール
npmにglobalオプションを付けてインストールしてください。
$ npm install -g simple-api-gateway
使い方
詳しくはREADMEに書いていますが、以下の4つのコマンドを用意しています。
それぞれの操作に応じてコマンドを発行すれば対話形式で設定が可能です。
役割 | コマンド |
---|---|
APIの作成 | $ apigw create |
APIの編集 | $ apigw edit |
APIのデプロイ | $ apigw deploy |
APIの削除 | $ apigw delete |
今後の課題
まだ、ローカルだけでAPI Gatewayのすべての操作が完結できる状態ではないので、そこまでもっていきたいっすね。具体的にはcorsの設定とか、mapping templateの設定とか。
最低限の機能だけ提供して、より簡単にローカルだけで完結出来るようにしたいです。
↑
今のバージョン0.1.7ではできるようになりました。
今は対話での設定に合わせて、できるだけ簡単なyamlファイルで継続的な運用管理が出来るように開発を進めいています。
それでは良いAPI Gatewayライフを!