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.337.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18a1f9b6bf9976a751797440e7220afe270be366f06702993fa4e1f0d1092816 |
|
MD5 | d7fd8c44529a162a7fd843c06fafe09d |
|
BLAKE2b-256 | 012670ae7735b6189ca3e56237b4f84a24b5ec24deab8bb15279e2a26f76e782 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.337-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f17f462f70a33fb42cbd8e913d08907344f68693ca3cb8fe88785235d5ed0bfd |
|
MD5 | 4050f5e3945999b3a13fbe9f91cb5a05 |
|
BLAKE2b-256 | f24bf123331448950feb0b1de5f04b42efc8af2f79e6aa20bb0d9f90adec0b32 |