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.242.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a68c61981beb250b9140ffce23ea00973283bd7eab6a4e421361c394ec14e71 |
|
MD5 | 088c5650bcfffc7f2ebfbf54d65c4119 |
|
BLAKE2b-256 | 5b6c81199bcd072a5c2b6e0334341364dded27a9494ca8169a7f3bae5c4a5925 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.242-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbeacd16430a44582fffab0b7e0ad72918ed8372f7013ce6489a6a68b39da7e7 |
|
MD5 | abcbfdcf1975f3e1a4ce77b6339a1e44 |
|
BLAKE2b-256 | 2bf7b4ce3d339a075221afbd427a75796d422a2dec5ac26d5d75b1a3284b3b90 |