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.790.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8fc38f864cd7340ed78e1b6f9a5b6f03346f16ec859108c5778be6a12f3579e |
|
MD5 | f157b0d6629d5903b4e081f35f701c4c |
|
BLAKE2b-256 | 4ecb8a7b3835fdbae41f081f728c5357b8cdc8ea9a4623c219c6f0de3d8ed30a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.790-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25a10b49baaeba91971e0ef7adb59d9cdf75812d5c74d4fa98cd41f3d81cde0d |
|
MD5 | 020db6cbda76503877fc8c9ec29ca3c5 |
|
BLAKE2b-256 | 506a53c46073305d65b6cc7917bb2b7bcd6fba0796f57080904555627e5ce32b |