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.759.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 44ff5bb18e0e944e6e529c0dac654070f78ab6d2f2dcbcf769a6c926e8c62322 |
|
MD5 | 3d0b98db169b7ad51793c5c6b35eb39b |
|
BLAKE2b-256 | 2139aba1a881a76509706c128fdfcb3746326c7c3396c91b5c7f46a1e4543339 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.759-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b22ea74040a48a7f3a654d5e1ff3486f509e91129cb326baaf50069ef8a495e1 |
|
MD5 | 69bde5c8ee1e7132e6ccca69ff2ed5da |
|
BLAKE2b-256 | 6596c129f5b50f6231a9135cfd5c6911685cd67381db50812238ea6852b3ca1e |