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.439.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eaac9ec983e150f882959f8c266d41b8463da36d71bcce1671fe952d3726cc0e |
|
MD5 | 16ef00005e8600180d9cf90a73e0b7ea |
|
BLAKE2b-256 | 5cbb524116848fb1f8a1b71b0b9cf3782ee321e95c3c44d673aab39d9ff0eb4d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.439-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e7843aa47fd1710c0a2d00a8422abbcd874d810a7c3c4ba378142aa7bf236df |
|
MD5 | a5d51ba4ddab2435a13e372dafdca4a4 |
|
BLAKE2b-256 | 4290c5bfa90c847d3c6bb82ff331498b188982f9aaa028bc5aee43ba66d520fe |