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.158.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9bfe12e59353757a619a31f9928a1ec441a33d97018a7ff67f92db2390b65077 |
|
MD5 | e272d9ed2e1f5287598f957e5a5c27a9 |
|
BLAKE2b-256 | f6af30b2dfc0c47a291fe787b92fceab798d8d0950ae53b438ea992b6a4be5b4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.158-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61e4e0e0a9b3bc0053328bab84cd521614aca79a38274469b9df6c5f3a1eb802 |
|
MD5 | fffb9fdd8c1ce66d09e8320c5a061947 |
|
BLAKE2b-256 | 9d28722a044470c9f7b24e4d8121b86c694f16ac5ae730e35745f66de80df8da |