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.730.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d43ca58fcd22e6dfc8b3a29aaeeda6f93704e9ecd92d5a8c1baabc581ac7e6f7 |
|
MD5 | e008b0b0aa8d2587078c9b2b162cff46 |
|
BLAKE2b-256 | 6257ae351bd68f23a60c850316744e04bfae3b38cac3169a643fd7d7895391b9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.730-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c56935e1b7e84e6f278c481bfb88a676e1794dfa8caec07faa71734e25f4de49 |
|
MD5 | a0be1ce3404fc7252e204978b1b3502b |
|
BLAKE2b-256 | 41752ed104da99d7bbf0218f0227c6fd0a6cf8f9ba879944e9a44026eacfeeec |