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.833.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11682656094b22370df1fa879b2364f682bfb24feaa5d44a35309d27c546cfe0 |
|
MD5 | 2f4f4b3f78d759cc48d3872aa4027dc7 |
|
BLAKE2b-256 | b02938390e195b14971964fe0b423bb5c87d5aee952e3a26561a8639521ff611 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.833-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c737ee21c168ca2a968e8d5cadc63b2a7728242443b73b6d0265857822b7ef82 |
|
MD5 | 0cf0f84e8105c58d326c63edda59d613 |
|
BLAKE2b-256 | 88dbcfab5b52be7242fe2a3f3558dcbf46d1162c39054831f1d5980c38b31c38 |