Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

API Gateway to ReadMe.io synchronizer

Amazon API Gateway ReadMe.io integration.

The modern API lifecycle does not end once your CI/CD pipeline pushes a deployment to production, and the API becomes available to your clients. They still have to access documentation, try out different parts of the API, get notifications about changes, etc. API developer portals have become standard for any business that's offering APIs to their partners and the end users. They help your clients to consume your APIs the way you designed them and get all the necessary information, guidance and initial support, and help with the troubleshooting tasks.
Amazon API Gateway publishes a regularly updated Serverless Developer Portal application in the AWS Serverless Application Repository and on GitHub. However, there may be cases when this application is not enough. For example, when you need to integrate APIs across multiple vendor solutions or deployment targets, or when you need more complex API grouping into various products. In such cases, we recommend looking at our partner solutions that may fit your needs. This example shows how to integrate one of the partner solutions, ReadMe.com, with Amazon API Gateway to make sure that your documentation is up to date and gets changed every time you change the API.
This example implementation reacts to the changes to the API Gateway made manually or through a CI/CD pipeline. It will synchronize changes from the API Gateway to the developer portal in ReadMe. It does this by exporting the API Gateway OpenAPI definition and uploading changes to ReadMe. Optionally, it will delete the existing definition when you delete an API Gateway endpoint.

< Back to repos

Clone this repo

git clone https://github.com/aws-samples/serverless-samples cd apigw-readme-integration

  • Language: English
  • Runtime: Python
  • Level: 200
  • Framework: AWS SAM
  • Type: Examples

  • GitHub icon Visit the GitHub repo for this workflow.

    Presented by Giedrius Praspaliauskas

    Giedrius is a Senior Solutions Architect focusing on serverless at AWS.

    Follow on LinkedIn