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.410.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff42e2d79670898119b61063b1a68c0e3b9c21dff02d0d8f9239fc2caf7b354c |
|
MD5 | e2f526e95e7983a4d6c12a4ecd80ec9d |
|
BLAKE2b-256 | 97cb0aff41c6d515b289d899b3818e08cd5c2fee1ca1306749acf1889e6fea96 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.410-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a61cf3eaf9b75dbabed2fcdbc8d8227f8e0cdc052426d85e9f7ef55b117d8f0a |
|
MD5 | 3df5b0ac6f43089dd2609aa41ce4b8e9 |
|
BLAKE2b-256 | a7b345c4eafa732642aa0f87eb2898ddf6b96724381947f685e10b24a7ce7d8b |