Skip to content

Latest commit

 

History

History
30 lines (24 loc) · 3.19 KB

README_SAR.md

File metadata and controls

30 lines (24 loc) · 3.19 KB
Raw

Introduction

The Serverless Developer Portal is an application that you use for developer engagement by making your API Gateway APIs available to your customers through self-service discovery of those APIs. Your customers can use the developer portal to browse API documentation, register for – and immediately receive – their own API key that can be used to build applications, test published APIs, and monitor their own API usage. Alt text

How to use:

To deploy

  1. Enter a name for ArtifactsS3BucketName: this will create an Amazon S3 bucket with that name for storing the catalog metadata.
  2. Enter a name for DevPortalSiteS3BucketName: this will create an Amazon S3 bucket with that name for the web application code.
  3. Enter a unique prefix for CognitoDomainNameOrPrefix; this will be used in the sign in page's URL.
  4. You should leave all the other settings as-is unless you need to change them. For example, you can optionally enter a custom domain name in the CustomDomainName field.
  5. Acknowledge that the app uses custom roles by checking the box "I acknowledge that this app creates custom IAM roles."
  6. Choose Deploy.

Viewing the portal

  1. Click the link for "View in CloudFormation" or open the AWS CloudFormation management console directly.
  2. Choose the name of the stack (aws-serverless-repository-api-gateway-dev-portal is the default stack name).
  3. Open the Outputs section. The URL for the developer portal is specified in the WebSiteURL property.

Updating to a new version

The Developer Portal follows the semantic versioning scheme (major.minor.patch). Changes to the minor or patch version are backwards compatible so you should feel safe to get the latest version. For changes to major versions, please see this page on updating.

To update:

  1. When deploying follow the same steps as previous and use the same values for the parameters. The only difference is passing in a new value for the stack parameter StaticAssetRebuildToken. You can use any string for this as long as it is different than the previously used string.

Next steps

  1. Publish an API on it for your customer to look at. Learn how to do that here.
  2. Customize, own, and brand the portal. Learn how to do that here.
  3. Setup a custom domain on it your customers recognize your brand and the associated APIs. Learn how to do that here.

To learn more about the API Gateway Serverless Developer Portal, read the documentation or visit the GitHub repository. For more information about Amazon API Gateway, visit the API Gateway product page.