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.525.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c014f87fd491a755898ecd0fed8905d0775711e4637ed184a26c3d437afd7c2c |
|
MD5 | 6571b6f8ec42fe54d355b990f3fb3dae |
|
BLAKE2b-256 | 25042f3425ce549a8d8e45cfe19ccbd484c753ca90034c10a6474cb43b9805e7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.525-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01119e260b85892c4690570179928f6001d43d4c4499c888bf8d914e014cdc5c |
|
MD5 | 4b0d4209b3e545b6619367e57409b599 |
|
BLAKE2b-256 | 0a12999958b52d055d01dc867497991fb0e5d323329a51baeb60ef9acc93cd3d |