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.685.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 714917cebf647e2b359bafda29bed12d171a7135ea63144dc1a132c6cc132e28 |
|
MD5 | 103070e5c04ee484dbda72be6a00bfff |
|
BLAKE2b-256 | 6e618c8ab2795b50f5db859be4cdd5ae36c5644a6d2a82c80533b3e485e6e11f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.685-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b3c948763665338911ed79e60627e697d9080144370ddfc27d3531c5e76fb04 |
|
MD5 | 1e8978648c1a47ac8078f3756679ebb8 |
|
BLAKE2b-256 | dfc43a8661ec1651bf504bfbf5235dec48b6095df16949ead1b5a09c30d43779 |