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.898.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7bcf1dbee9e3eaa1e5b4b245017da27f2b2a1b68be8d16b8642e6f89c12d2fe |
|
MD5 | 640006ded78856103aec0ad0bce53a22 |
|
BLAKE2b-256 | 766ef3bdbe37b9cdc4a962417ed11d43647078dba13cdaa438dfce1a57115c55 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.898-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a69c517f7d52617d514bc783124a4fe54f9c710b22315129c577de9fa335388f |
|
MD5 | 802d63795c91973e922ec0d5b958579b |
|
BLAKE2b-256 | ff145254ee2705128a1b3bbfc02ad3621fbe99b4b47ad215894b92bedf0228df |