[AWS Labs探訪] API Developer PortalをAWSで構築する

AWSのサービスを利用して、APIの開発者ポータルを構築するプロジェクトを実行してみます。 AWS Labs探訪とは GitHubには、[awslabs]というAWSが公開しているOrganizationsがあります。こ […]

AWSのサービスを利用して、APIの開発者ポータルを構築するプロジェクトを実行してみます。

Table of Contents

AWS Labs探訪とは

GitHubには、[awslabs]というAWSが公開しているOrganizationsがあります。ここにはAWSサービスを利用したサンプルコードや新しいSDK、オフィシャルイベントで開催されたワークショップのサンプルコードといった様々なコードが公開されています。有名所では、SAMなどもこのOrganizationsにホストされています。

ここにはそのまま使えるものからprodで使うなと書かれたものまで玉石混交です。AWS Labs探訪は、ここにDiveしてみて仕事に使えそうなものがないか探してみようという企画です。

今回紹介するプロジェクト

AWS API Gateway Developer Portal

SAMを用いて、APIの開発者ポータルを作ることができるプロジェクトです。

プロジェクトをセットアップする

まずはGitからダウンロードします。

$ git clone [email protected]:awslabs/aws-api-gateway-developer-portal.git
$ cd aws-api-gateway-developer-portal
$ npm install

SAMでプロジェクトをAWSへデプロイ

SAMでリソースが管理されていますので、sam package -> sam deployでAWSへデプロイします。parameter-overridesやs3-bucketなど、書換が必要な箇所がいくつかありますので注意してください。

$ sam package --template-file ./cloudformation/template.yaml \
  --output-template-file ./cloudformation/packaged.yaml \
  --s3-bucket YOUR_S3_BUCKET_NAME

$ sam deploy --template-file ./cloudformation/packaged.yaml \
  --stack-name YOUR_STACK_NAME \
  --s3-bucket YOUR_S3_BUCKET_NAME \
  --capabilities CAPABILITY_NAMED_IAM \
  --parameter-overrides DevPortalSiteS3BucketName="custom-prefix-dev-portal-static-assets" ArtifactsS3BucketName="custom-prefix-dev-portal-artifacts" CognitoDomainNameOrPrefix="custom-prefix"

--parameter-overridesで指定するS3BucketNameが２つありますが、作成済みのバケット名を指定すると、エラーになりますのでこちらも要注意です。

sam deployはCloudFrontを作成する関係でかなり時間がかかります。ちょっと休憩するくらいがよいでしょう。

Successfully created/updated stack - STACK_NAMEが表示されたら完了です。

開発者ポータルへアクセスする

ドキュメントにウェブサイトのURLを取得する方法が記載されているので、試してみましょう。

$ aws cloudformation describe-stacks --query "Stacks[?StackName=='YOUR_STACK_NAME'][Outputs[?OutputKey=='WebsiteURL']][][].OutputValue"
[
    "https://xxxxxx.cloudfront.net"
]