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.61.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f60a3cc4d4747acceb07e82c540a50a0372752f2af06e8335ab1e14d3808764 |
|
MD5 | 67d48ac3f6f16632eeb8de04df5a1d64 |
|
BLAKE2b-256 | 90f972667be76888b27aff9368368e252df01fcce4b806c353bad3e4584f7c1e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.61-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 469e5a81b4c689657587508524cc46966a9a1e22a3f6534371f0857eca69d17e |
|
MD5 | e1313916f70e423af0b57cede97286de |
|
BLAKE2b-256 | 3b8d3f1138fd64037af76e79fcf5c35b96812677e779d95bc686a80813c2d826 |