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.677.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f907629e3cd6faf30836d55a32b81fffb338fb21cd719a3c62782dbd08f30b48 |
|
MD5 | e341bcbb465612d99a65113c62c31f7d |
|
BLAKE2b-256 | 93f6a84b1dee99ee137c20ad44a09dbe2d3f43207935e045453cca576b15ee67 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.677-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be44d1a1faf8c71be2c538f38e1e8d234d66ef49090c4e874f6c6f0acd67724d |
|
MD5 | ecd9362e759fb3b7a74981e55540e8b7 |
|
BLAKE2b-256 | 71f399a313d1347730d367b6269e56017882c91f7a54ac20c863fbbb1caed40c |