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.821.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e538cd084f9ca1105738911c65a8887a003fc0cd27118dab8cb5cec9d913716 |
|
MD5 | b72f443213b97f0b24db712182db7b8d |
|
BLAKE2b-256 | eb5e275ef4a125bfd15400c717e17f10513dca9baf33567d63ae2297d4bfe384 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.821-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10e2cbaf1507e4586c274ebd99090ce76adbbbf9901c48d61c5d23d7fbf5ba49 |
|
MD5 | 52b44677df263210bfff94e5d0d6bca7 |
|
BLAKE2b-256 | 4f8d1896aefdae6fed6d10e6b03a7a5d7fbb8e1f178703d752f05869f5efc322 |