Metadata-Version: 2.1
Name: oai-sam
Version: 0.0.1
Summary: Generate SAM template and AWS OpenAPI extended docs
Home-page: https://github.com/fulder/openapi-to-aws-apigateway
Author: Michal Sadowski
Author-email: misad90@gmail.com
License: UNKNOWN
Description: [![Build Status](https://travis-ci.com/fulder/openapi-to-aws-apigateway.svg?branch=master)](https://travis-ci.com/fulder/openapi-to-aws-apigateway)
        [![Coverage Status](https://coveralls.io/repos/github/fulder/openapi-to-aws-apigateway/badge.svg?branch=master)](https://coveralls.io/github/fulder/openapi-to-aws-apigateway?branch=master)
        [![Python Version](https://img.shields.io/badge/python-2.7%2C3.3%2B-blue.svg)](https://www.python.org/)
        
        `oai-sam` is a script generating a SAM template together with OpenAPI documentation including [AWS OpenAPI extensions](https://docs.aws.amazon.com/en_pv/apigateway/latest/developerguide/api-gateway-swagger-extensions.html) from an OpenAPI/swagger documentation.
        
        Simply provide your OpenApi/Swagger as an input and then use [SAM CLI](https://docs.aws.amazon.com/en_pv/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html) 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](https://docs.aws.amazon.com/en_pv/serverless-application-model/latest/developerguide/serverless-sam-cli-install.html)
        * `sam package --template-file out/apigateway.yaml --s3-bucket <SAM_BUCKET> --output-file packaged.yaml` (See [sam package](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-package.html) for more options)
        * `sam deploy --template-file packaged.yaml` (See [sam deploy](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-cli-command-reference-sam-deploy.html) for more options)
        
        ## Show list of available arguments
        `oai-sam --help`
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=2.6, >=3.3
Description-Content-Type: text/markdown
