{"repo":"alma-cdk/openapix","free":true,"listed":false,"github":"https://github.com/alma-cdk/openapix","clone":"git clone https://github.com/alma-cdk/openapix.git","description":"Combine the power of AWS CDK & OpenAPI YAML Schema Definitions","language":"TypeScript","stars":101,"topics":["aws","api-gateway","aws-cdk","cdk","openapi","rest-api","swagger","aws-cdk-construct"],"license":null,"category":"api-integrations-sdks","readme_excerpt":"Generate AWS Api Gateway REST APIs via OpenAPI (formely known as “Swagger”) Schema Definitions by consuming \"clean\" OpenAPI schemas and inject x-amazon-apigateway- extensions with type-safety . 🚧   Project Stability This construct is still versioned with v0 major version and breaking changes might be introduced if necessary (without a major version bump), though we aim to keep the API as stable as possible (even within v0 development). We aim to publish v1.0.0 soon and after that breaking changes will be introduced via major version bumps. There are also some incomplete or buggy features, such as CORS and CognitoUserPoolsAuthorizer . Getting Started 1. Install npm i -D @alma-cdk/openapix 2. Define your API OpenApi Schema Definition in a .yaml file without any x-amazon-apigateway- extensions 3. Use openapix constructs in CDK to consume the .yaml file and then assign API Gateway integrations using CDK HTTP Integration Given the following http-proxy.yaml OpenApi schema definition, without any AWS API Gateway OpenApi extensions: You may then define API Gateway HTTP integration (within your stack): See /examples/http-proxy for full OpenApi definition (with response models) and an example within a CDK application. Lambda Integration Given the following hello-api.yaml OpenApi schema definition, without any AWS API Gateway OpenApi extensions: You may then define API Gateway AWS Lambda integration (within your stack): See /examples/hello-api for full OpenApi definition (with res","default_branch":null,"files":null,"tree":[],"storefront":"/r/alma-cdk","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/alma-cdk/openapix/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}