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.654.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c93913cd041010bd1b3c1b1b4d89465e319355b021954783f58f2fb459c76415 |
|
MD5 | 89974ee60350fc8223e3afbc68e549f1 |
|
BLAKE2b-256 | 25973579266426c8609f6e283bdd967e6433926fa62afe378e5d425a44961ccd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.654-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61c540cdac7bcdfbd0c719180a89ad2debf3c7ae3919a0490b0193d89483ebbe |
|
MD5 | c3466279c5c5e532c38d559d2184f14f |
|
BLAKE2b-256 | 45b31baa286348f11b8a549bbb703f9640031ce739ac8ef9714397ecaf79692a |