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.150.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5b2b80c0c449644b829647e291e2c77e5a6f16b806879470d20a1427b088418 |
|
MD5 | 193a448a3d4d639faab2241365775de7 |
|
BLAKE2b-256 | 165f747cd8f45e51292f776f441b818ee88addf4da081d029a80668d967b4142 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.150-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39af3b017cb752961b46957e5461c9a96c14b7e994ce3c8671223a13bd6dfef0 |
|
MD5 | 1a06331f72247bdf0552f393bbe0ed2c |
|
BLAKE2b-256 | a36469f58405db7961ccf560eb12448b49525f61635a436c0479d3a4529ceec5 |