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.592.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00e0a1bea9c9a4bf7108b1e885950a96f0371005b5374bb51b3b39dbd4f43fb0 |
|
MD5 | 7d8c913134ad7c5e4d0a27fa27e240cb |
|
BLAKE2b-256 | 37f4aa7697c2a8a3c6a767c3d5926505a75739d30ebac5be8cdaa1016aa9a73a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.592-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2d7bdfcc6f2566b586d887a4935f8a4d8291bb3547de810ff7677e5dc4ee38c |
|
MD5 | 419b1fa70e6ac0f32cfae45377c70695 |
|
BLAKE2b-256 | ea9e8323472efeed393d59cdc530ecc26be0ff4469c5d465e87226ca4a287453 |