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.769.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b47928da4cc754251d9f388bd5a72999444a12121d60aacf797905f764c50ed |
|
MD5 | 6c9c2656df32017b39d330a8d249bf95 |
|
BLAKE2b-256 | 119c8e460d2470371469b2c2b46e5b6b356d6f54cfdf01afe10a6c92a38dfe9c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.769-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a855e2c042ee4e2da57630e45e9594c93554647832d9fce191dc448e65c5aa80 |
|
MD5 | 26b6d0924967a39458370adde5604dfd |
|
BLAKE2b-256 | f84fef31712a65dba51547543c3fd0c8466b7c1a4a6785e3b9560602623dd0c7 |