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.879.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f41312f071d0263434d9f25074dd666211fcb2166d7b5d3a4ecef1e0a487dcf3 |
|
MD5 | 65e8ff86468aca8398f2831f614df199 |
|
BLAKE2b-256 | 9493efe52f7d619d09daaa9441a913e8df44f8bba2b7649e46edca01f8a71187 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.879-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efeace5aa52d4650419d1736da0817bae2919b15679795510c3c76ebc3c1b8cb |
|
MD5 | b1e774205b22b3023b9f3fd4c2966997 |
|
BLAKE2b-256 | 2232fb19d83abc7bac6099233bead80a355af90d4614910ff51bf89473103203 |