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.672.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05c2e6b3454aa1f9946b33968e0dd846478b3dc1a761e2425e77e8c88577a1bc |
|
MD5 | 4ff3ffe761b707db99ad7ce5102d77df |
|
BLAKE2b-256 | c53e33c165689d3a673a7365b091a1af2ed162a63c77788abfb2f45f597a3a95 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.672-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f921ed9f021403cf79f2fdcf2c8a7348af62bb9fc0e417ff758d7d469d9bbc13 |
|
MD5 | 31174425761f6c2da0444c9593e6fc36 |
|
BLAKE2b-256 | 5880510d7f8bbee9255396f921c85d780755d17126d9456ecbecb8368fc0f969 |