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.210.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 48f274bc50ed5b088fabd4d948120e67e7fbc932de9e8881e72c6f592a1b303f |
|
MD5 | 0f614fde7d4b976ae78b7995b34d8a63 |
|
BLAKE2b-256 | 12652f81091b6a313f07db6ec1adda2cb5845aaaa5488f16eb709edbfa2ba95e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.210-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30a1d19e5426d0cce02c0b2303f2841e58a2c8eb17d39422901f7ae26267137f |
|
MD5 | 0f94a91f10fd8114ba203f2f3db0b78e |
|
BLAKE2b-256 | 88e8716c45c1b2a9285615d156e794b9a410ed8ca61864149bf4f3323c450022 |