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.318.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5b367b5d64070266617cf6b7b6de916908f27b26cffc58bf826570e644dedf2 |
|
MD5 | 72328500c30071e55e7d98b077cbaa52 |
|
BLAKE2b-256 | a6c59ccfa5bc3dbb515798d4f5913e31e8aa4e7b7e45d532cc3302a0d01c3a70 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.318-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7153a5c4b76eea3cde2961bb112607069cb148a6e06c6137d4ef84ad7dd6333 |
|
MD5 | ea202763e014e50f53643fb2285a554b |
|
BLAKE2b-256 | df906fce9d2a824110c732e55a96f942f8209d84ec514ff29141da7e7f41df78 |