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.91.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a762093e9ac4738346deaaa1c9e05f2ea8ae1267d6ab2d536e0afb41a88d816e |
|
MD5 | c5d2e31ed82a192b950cf27a4ec3478d |
|
BLAKE2b-256 | 8ea76cd6148548ef371d2444fb8a9cd67fc68ab444c1c8e390e1916d994b8d98 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.91-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de21417026d3d15b5b6b9af5d6affe944b1f983f03f5a4a660c1efe2e375ee9a |
|
MD5 | 5e5375045b6ebb03a21462c9e06b1412 |
|
BLAKE2b-256 | 0c735fb1a5ec79ac0e7e3e3df39012523dd2637f5287c83059f95c5ee1aa0238 |