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.296.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87e46e9de215fb5f7e6a69d2ce1b8a68cbab90223334036c2fcc2a26b0469039 |
|
MD5 | c90e22f0e1ca0aa2724b9d474cde046d |
|
BLAKE2b-256 | 1e03b65439bf560e445af0e048696372e0591b44e121a523a5abedc502cc3851 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.296-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2cb9803c5b3328141fbe8084cbfaa43fe97c443084feb1dc49878c3e541a2b7 |
|
MD5 | 5d701fa3b560b7cf304e7acbe2d9a84a |
|
BLAKE2b-256 | f03598e1fb0a5885fa52be8a13aa567a8e28493118b70a15b4e42f2821371c0b |