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.839.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf4f766e4d5ddc7f1961fa5bded710c72387cd56be8d49dd13e0198183160729 |
|
MD5 | 8367d9ee4d4d30c4821f5eb8fe35bd3d |
|
BLAKE2b-256 | e13e20e52fb501ef698c471cfbae4dc4e59a958fff375aff708d0c85f481af61 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.839-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d85d134db57069013f2d4f7becb52c31e038ede2b998a578dd0d9e26f4a159a9 |
|
MD5 | c23bc623fdba9c791a71e14d152d3f4e |
|
BLAKE2b-256 | 9e9699059c90d8900f5a21cbb3602daed5c0d40b843565eb05bba978e1799158 |