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.206.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a064827f0aae9967d5beb23236190e61788043806aac2e05ec0a6bf7dcf7aac |
|
MD5 | 06a192475daf03f82a1e2679954881a8 |
|
BLAKE2b-256 | 017a91f968a0c66d33f8acca26802cdedab5bbdb93dbec9609a3b6cd8933a945 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.206-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b51b67452de746b08510d82a86d1d58324067faf42efbf3cfe8fa5a38fa60881 |
|
MD5 | 163f0936e84bff18bcd305ec64979753 |
|
BLAKE2b-256 | 0c3ea1de66aaec8097242c0d84aa4fe696eb45c82284cb4c6c7f4840f098ec2e |