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.779.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65956dad6fedda8b03b990e79cff47d2f16eba30b93ff557d36e4f0e9d2da302 |
|
MD5 | b799308f97ee0f3dee73f80f82210d00 |
|
BLAKE2b-256 | 82013bc8b9bab031c5227c45df0e5dded29b3a331b14b3e02ea15ab207d4f680 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.779-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cf984b4901c75599dc6b438408bc4ce184b883f41fa75991cbfd758b3322ae7 |
|
MD5 | 47eb86990d37165a60bfaf88b8d39e05 |
|
BLAKE2b-256 | 217b5a11be50f001cabbcf134c6aac516a5b58365596417461cb5d0c35d06929 |