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.34.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63446ecb9ca178528901c457d48c23c2811c4c0b4d998b7aecf463d066704623 |
|
MD5 | f14eed8b34825ca516d0b6a9fee52e63 |
|
BLAKE2b-256 | 2cd9582d3c70a51487b84e232ab0cc312985b2b6c3a04615dfe24dd1619c75dc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.34-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6b7737a788736efc31c5df21db8ba297a1190aaa941543df25cd3afe889c570 |
|
MD5 | 086b4550cebf69c9b25320228280c176 |
|
BLAKE2b-256 | 797a4f9d0eb59a37a9cde380b40e1b313b4748259bd443005ebfc0f57fb4262f |