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.305.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c5d22bed0aa5f6fcaeae7134d9f5097316421c32b390751f1031560ebd5af8b |
|
MD5 | 90a996509618474cb8e4be3972b5931c |
|
BLAKE2b-256 | e13dd473a89afb9e150700258e5e5b5c9f0d30b1b0fa7f8c9a33401927efe22f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.305-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab357199118cf404da50cf5d37846eed91cb20be68d866e6f39dfdbe884ab0c5 |
|
MD5 | d66fc07273dd41f8d4612e44656bfdae |
|
BLAKE2b-256 | a0afa7ae15cad1e9c863e680d9d3ddac3938e785e4cfb0b530a7e5657ce58d29 |