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.761.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a9e2fa672c4cc881f38ab5cad451cbaca380a5653a36c929cf17917a5a0ba23 |
|
MD5 | 74e3882f8b7b7fb8d7cb024e306d01db |
|
BLAKE2b-256 | 426d157254ad2e27d5b7e386419380e073bee93cdac19e9c2bd07e03ae57ffae |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.761-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5686fe753a69ecb7e5be180263492b0fcafff28011198b4d450198f9811a1212 |
|
MD5 | ca2dc05ce03736ee0f5364442c20aa53 |
|
BLAKE2b-256 | c33c03abd9a546f94d0e78e4aa86d8a038658e2cba0dc440e8b670d013e3f429 |