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.294.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1febc8d6a4cef6d1e44ffe8f4e4d541c23190bbbf164972b3813e829ff6fd4f8 |
|
MD5 | bedbaf3ea18309461b0791754b278e1e |
|
BLAKE2b-256 | 74f9b809652f16fc609384b25404a60852c1f7ec38c70efd373cd539c4e5f916 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.294-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8709875c1ebc7b16f2fc2223c1fa8d4e68d67a8936735836eda2e4f2da75eb7e |
|
MD5 | 25cdf2b143578cd4a29e3bf56fc320f4 |
|
BLAKE2b-256 | 24791f19c6748cb472a111b0b2923491bc0f8538f14dab8c13dedb21d034c07e |