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.283.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 458c0382c191b87e85637512a60fddf344210b88c5467d956e2ac7a77d7760e1 |
|
MD5 | 694ad05aea704ab02d60af98a68b2d8c |
|
BLAKE2b-256 | 8f83d368cd11384db6606a63c8f248661fe56d28281593a8052c8394799beaab |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.283-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f92c90d41195012316e98d40b64052fce501193a6f1abcb8e574f03c5bc083a |
|
MD5 | 1429b9d7ce455ce1df0cc1c8e74b9ff7 |
|
BLAKE2b-256 | 52001a695bdbf320145cfdb1aae40cd086e3737d34e402847937f1c112971d6a |