Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.755.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8678b3ca1159e9557ec007d486b984c2b1ec4c41e9831bbe0f41bd1bac2d09a |
|
MD5 | f3a0d52ad8749eed7ce953c6814ecdfa |
|
BLAKE2b-256 | 38dcc39ad7165140694a46fef6cea99d808f7965dec8f854ebe26edf99b5805d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.755-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 276ff0a30bbb5d78a7d7fc86fff93b311f8d89ac8681393837742555757d9e8d |
|
MD5 | c8fa772163cda150cd51c22ef97c3e87 |
|
BLAKE2b-256 | 16d570929e41c3029598031d19826c745164d7ee50ea11fa3c556770217344e4 |