チームだけに公開したいページは気軽に「Amplify Console」するのです
2022/10/04
前置き
NTV案件ではバックエンド開発が先行していて、設計やAPIのレビューの依頼がGPAW(=でび)にきます。
APIをレビューする際、最初はバックログのWikiに書いてもらってたんですが、
抜け漏れが多かったり、記述が一般的でなかったりしたので、APIの共通仕様であるOpenAPI(swagger)にしてもらえるようにお願いしました。
ここから本題
OpenAPIをwebで誰でもみられるようにする場合、昔は自分でサーバー立ててhostingするか、
swagger.yaml ファイルを手に入れて https://editor.swagger.io/ で読み込むなどする必要がありました。
色々とてもめんどくさかったです。
AWS Amplify Consoleを使えば。。
自分でサーバーを用意する必要なく、githubと連携して最新のAPIを定義をwebに公開できます。
basic認証も秒で設定してくれるのでとにかく楽々です。
手順は↓の記事みながらやれば10minかからず終わります https://dev.classmethod.jp/articles/amplify-console-swagger-ui-auto-doc-hosting/
FE開発でもめっちゃ便利
NTV案件ではOpenAPIのhostingに使われてますが。
OpenAPI以外にも静的ページであればなんでも公開できちゃいます。
FE開発をやっていてよく面倒に思うのが、Storybookの公開なんですが、これも秒でできます。
サーバー立てたり(そのために稟議書いたり)、github actions のworkflow書いたりとかの手間もないので、非エンジニアでもできます。
おまとめ
アクセスが増えるサービスには向いてない & MPAは公開できないので、 あくまで会社やチーム内に向けたWebpage向けになります。
とはいえ用途は多くあって、楽ができるはずなので、覚えて帰っていただけますと 🙇