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.573.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3bbefa7f0a68a27c4934e19de187e52704fc7486f6954140dea128cec332d42 |
|
MD5 | de1abf6ff37208f4cb7b20cfd9fd1049 |
|
BLAKE2b-256 | 0040140ed019e01ed629aea231f040791dd1fe47b7601673eee10ef6a8344331 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.573-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c3fa2663fe2ae3f2577dc80769537938625cdf4e29b52d93406d814adc348e0 |
|
MD5 | fde0444a9543dae455a93870160e1d25 |
|
BLAKE2b-256 | 1c1b6a87995f88219c551e7e3375ee8bcec58564d2a9ec727269a0295a05d289 |