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.47.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 80e346e89a19cf443038023451bbe3d4189c3f0cba4de311b4d69292744771b2 |
|
MD5 | e14dfc2064ef84bc804d100658139405 |
|
BLAKE2b-256 | 201fb8c7a491215eba5e5915a031a8da9442e8729611f60452828faf12654f0f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.47-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d6381d2ec2e6034d245243eb09288e4b3514c285e41622957adc0c34ff4c682 |
|
MD5 | dd2b0ae18fd605d7bac630a73534be46 |
|
BLAKE2b-256 | 45999f8c25a537a7c33fef53715779b0c6f41533688e6c2d5adc602d8500e390 |