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.602.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9f61da68a0439dcbf7b697b9de110f5fa9875a80c87b73279a3a246ec2c077b |
|
MD5 | 1de1132f671692b4b4a1165450d6e852 |
|
BLAKE2b-256 | 09063aac3c8056656cef55ab270bcaf7d290c60aa47d658554abadfdf6f97488 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.602-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6fcb621821a12ef647a842886036108cdabd0f07a9e8678f4b2979ef7185e55 |
|
MD5 | bdc688f338c455bad83b0d1bb96ad66f |
|
BLAKE2b-256 | c13b5eb2e430f8647095fb19265e7a18b3f8496bf69c1bd48ce101bf72988cb1 |