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.349.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7784a9f5144461d69fa553efdea6e6dc46e90d3e0ed57b13c0e7e54f7566149 |
|
MD5 | 95c7d6dcbf5a24fc05eb4ad3dddf5113 |
|
BLAKE2b-256 | 417698d4ea0fc8b4ee94dbbc58be8e4c424dcac5389c0c21e41dc18d73b03011 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.349-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2412c0c32894d04f0a85edeeaa56a0db0b511e861dd7a032489284886071d031 |
|
MD5 | d78924d39db669f1bd6d80ea171c5bde |
|
BLAKE2b-256 | 3afffdadd48ad2562018b9c5cca6232839438dd66f4e64bc0e89f86e663e6bba |