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.813.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 900ce101bb7eabb8d6b156f632a4e3a100deedd1ca90b7fd7fc0eb4a836a4b77 |
|
MD5 | 3cd322adf22905d865bccf2df2831bb5 |
|
BLAKE2b-256 | 00d0c147475f3fd16c97d8a7f8b76b2e0a229f30691c8906d3897d9464f3dfed |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.813-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f39afcfe61278ff8fb4deb5f243601fd05afdbc718001298d977c726a5ecabb8 |
|
MD5 | d3ab3df5248e2c6c0850cae54852fcaa |
|
BLAKE2b-256 | b3ee1e0aeeb66cff3afd1c30aca6c8a8ff4ff750e919b77c7416d7bb2786bec5 |