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.499.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50fec64c014c66d0c0fb837b79c7c0ce97d8a50c38ad14b12abba295e24d10e4 |
|
MD5 | 278e7b3d400be8971062c7ca322482dc |
|
BLAKE2b-256 | 4a7c7257f4c2c77aee3cbbed4652cd685daf270f593607abce88aa0236addec3 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.499-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81381b3b5aa26a8003009d6bc8fa7e61185657a62e45fa24596784a09cd8f878 |
|
MD5 | 0cf8bd9ef9ccf6d91075a8730a073317 |
|
BLAKE2b-256 | 342dccbbc55bcaa2797dc79d5f01fd9a5bffe0e2725b2d14ccb66364328859b4 |