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.326.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a70a02a54bbc94f0fb72cc2ef5c40f543e04d50652dda9a5b378366d84f081d1 |
|
MD5 | 7e0f8ec020d9415d077bc5b00c2494ce |
|
BLAKE2b-256 | 4ca20b5dc707fd220a4321a23b8fb657afb19f8bac60223a2815b236acdda00d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.326-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0f1f448aac43f8584d30cdf9c551b7c33678769b253b174a20c2cf7c8331188 |
|
MD5 | cef352022a2c7a902a6523a4313107b2 |
|
BLAKE2b-256 | a32b6239310b9f53d7799b904f01250f61bd0c0a866ca39f2136b6509939078d |