Skip to main content

Generate SAM template and AWS OpenAPI extended docs

Project description

Build Status Coverage Status Python Version

oai-sam is a script generating a SAM template together with OpenAPI documentation including AWS OpenAPI extensions from an OpenAPI/swagger documentation.

Simply provide your OpenApi/Swagger as an input and then use SAM CLI to deploy a working AWS ApiGateway.

Install

pip install oai-sam

Usage

Generate

oai-sam -f <OPENAPI_DOCS> -u <BACKEND_URL> -c <CORS_ORIGINS>

e.g:

oai-sam -f https://petstore.swagger.io/v2/swagger.json -u http://petstore.swagger.io/v2 -c "*"

Deploy AWS ApiGateway

  • Install SAM CLI
  • sam package --template-file out/apigateway.yaml --s3-bucket <SAM_BUCKET> --output-file packaged.yaml (See sam package for more options)
  • sam deploy --template-file packaged.yaml (See sam deploy for more options)

Show list of available arguments

oai-sam --help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oai-sam-0.0.1.tar.gz (14.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page