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.608.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4189febf3baa881c3f72bf208e1bdccca80db6b9cbee6cf8d19d2e6883b8fc56 |
|
MD5 | 53667ffe27aef571a0a30a11c8149d20 |
|
BLAKE2b-256 | 98854fcb685cd823eeb59957e23103d4d8fb352c8672d1ee3b5fc8a60b1e4448 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.608-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab621e9063b378cf2eb5ac30b459c493465ed6adafd6d46b8bf06603af648f8c |
|
MD5 | ecac6abb49c456e3b0dcc1c9b12d5bf5 |
|
BLAKE2b-256 | 34920aa7e9794f1ac5268f80fd39aa72e50c2880eb535366c94595c9ce9eaf93 |