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.670.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aba5ab97b1aa641f0748e2d7b8f8740333adc1f373cbc543aaf3cbb4f359c4a0 |
|
MD5 | 2c1d62fa863dffd9076b140d9e7a3289 |
|
BLAKE2b-256 | 06ea97d4b889d8fe6044f37e722c80e9170c5e496827f86a93d13de5e45e7821 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.670-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f00610946225de74abdc52c1cde414572c168b295e20281a486e927544cd8bd3 |
|
MD5 | 0f229e0cd70ddd90bb58db78626e05fe |
|
BLAKE2b-256 | bec45a348d55039a53560c24cedc73f6ce2e29c8a1768da1ef5b88960f8aedd9 |