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.812.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6892a53019711f2b3730a3e82a82ed6591e268019cb8465c50b1d4316a3013ee |
|
MD5 | 438c412cb92e939bccb73e0936c07c42 |
|
BLAKE2b-256 | 5e2d6814adcea029f45907ce22bbda49a9936dc95b4db9b1d02cc8a0a7efb6d0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.812-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a17bcf82fa867f6a9b7bb5d14e39178dc7576961dc43a1a07c7bbb8e93869e1b |
|
MD5 | 9e2fcca9205dbb93192172f26df72846 |
|
BLAKE2b-256 | a4b29778502e6a924fbd2def4b56fc5a9ccb7a5635a350de9c3c4908cd5617bd |