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.518.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1dc8aeb57a62cb87d5443e42068fa444948b7dab4116fdaeafaedf7201a7b5a7 |
|
MD5 | 9ba38933a1bdeabb52b235541e6da47d |
|
BLAKE2b-256 | 4c8172dd57e52acd69518893505d261b4aa8feb30a7d4ce92a4978de3802e001 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.518-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03b6c874da295fa40fa94496cc977ca56dfd0c603013dd08327986687aa020b4 |
|
MD5 | 42fa4d114fe17de66a7e12400c642ffb |
|
BLAKE2b-256 | 5956a5b3bebee6c2b615576bd09b848ab2e029f50b696dfcb7287eae1303d4e9 |