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.552.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a88060eb0ef468fa5dc80ac7da857de544944fd275651fb4ffdd31899f1ad256 |
|
MD5 | 2641ad7a4e3abdb1b033b681245f8d96 |
|
BLAKE2b-256 | 090546b1013269c6ee93dd841be4c320e6a9cb30d373fe9c92f40b40cf928533 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.552-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31c7481c1092fc0fb5cf786cafbff15b4950570a1c23d65b3249c03c90eb1a55 |
|
MD5 | ead05b09b9a02c1c4507bcd1b087e999 |
|
BLAKE2b-256 | 5b1d19812bc50c9b8969a20f50800715eaba119b2044138137cbfcdee28881f4 |