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.882.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc04e9801add9906e3ae83cda0ca10730d58d3b157d9b93d66d39623cd8064fe |
|
MD5 | 5ae710c0a289f55c6299f77518941a32 |
|
BLAKE2b-256 | 6b1447208921c6a95987ecb160eaafab05797b8c28064a7263288c470dc3c7b9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.882-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f12060bf91c65d57e55e7edaf2f31d8e7280904ec007ca013ccaf5c193be46e |
|
MD5 | 5604f744e10a6c61d3ef3d41d3ef1a35 |
|
BLAKE2b-256 | 9dfa7f4013e9750c69b3924bccc053d63b17f2ebeab4f9d362b1bc2a6a8f09d1 |