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.372.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 623f2a0a7d7191e25c948a5846af9289064cd291de5ca07883c37e51462e4134 |
|
MD5 | 7678f3794676d58d3314792af84f3c47 |
|
BLAKE2b-256 | dffbb254d13e20c87ae21faf6847dd6af7dc81483256dfdac1a9b04d88e2858f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.372-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0a2ea789c9926baf0d1233ff77c790bf34e075c6fdee5d678d0795eefa1d370 |
|
MD5 | 69dc79e1f80002314fe975baf21f5003 |
|
BLAKE2b-256 | 4f41c59922098cd84dbe6fcef19c02771977650b027e50b64af7d7dae676df4a |