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.527.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81391acf8201e2cce98f08f5c4d0807c69c7e735cfe85958092c4b56f833542a |
|
MD5 | b85f907c718ae42326c3bdb653dadbeb |
|
BLAKE2b-256 | 5191395a40f76d044570879dcbd0dcc4365347b6415d7aa38614f4b21cb7f1d9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.527-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | beb5e1cc7f471a01da355f9dd7ddf3d34b2fe019a487b6cd6964c1c776c7ff2c |
|
MD5 | 0d5aec203a09cf13f0afe4d95e4f301d |
|
BLAKE2b-256 | 8716d588e41d8af0df69e57b51be04d280b8a7183fde2e2addf4deefee4ba255 |