Link Search Menu Expand Document

AWS

Import OpenAPI documentation into AWS API Gateway

The AWS API gateway service allows importing of an OpenAPI specification to create a REST API. The process is very straightforward and can be found here. Here are some tips to consider when importing the documentation:

  1. Remove any circular dependencies (these aren’t supported by the parser).
  2. Remove security-related annotations (These annotations aren’t well supported by the parser).
  3. Max length of fields are reviewed by the parser but the errors aren’t self-explanatory. Review the specification to verify that the requirements are met.
  4. API gateway errors aren’t great, but you can use this page for structure validation.