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.848.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 416010cd88db6b97a186af2bb22dae11a5bcaab504980d392cd489346c9055da |
|
MD5 | d8a83f22e4d7ea7c85e2a047fdac8f68 |
|
BLAKE2b-256 | ba411913b871740bdf7c0f9ef77c6a53b45bec5e50eba65fa1424b1d250a91e9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.848-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fdfe11454aca4eff5783e582bd72b8e61bf50169704f9eb9e83908e35636b97 |
|
MD5 | 2c27ea8b94162f77e190e3da116d8f98 |
|
BLAKE2b-256 | 70e68e78a17b730576c8b3895b366d4c78ef7b939786a0abebb061ab2faff581 |