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.383.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4288c42c41fd9301ebd7c63c8dedfb560fede7d733d19a1cde47a3849c9b815 |
|
MD5 | ae35c2d6d85e2502d36c385bb669ce5a |
|
BLAKE2b-256 | c252e69695e9ca1d3c4feb5119a0479238aeb4ce346057dc2fa4ae62ff6a5bee |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.383-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 285c72d1a7564beeeb84a6c000c1e2536fe8d925fc6e8368e8b34a9f73a9a0d1 |
|
MD5 | b1aafa3a5bc322b63ac737473065112a |
|
BLAKE2b-256 | 009b5156782b8d7ef93714f14da55c4be3aa8d2e446bd354175510aa2e66f590 |