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.891.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccf6e5dfaf13e6d7c55fe156a2f194aa9897725b44562a934820192039e24a07 |
|
MD5 | a80149f27fdbab401b241f114b1e6120 |
|
BLAKE2b-256 | 94b7af24f0ac3709181c5be2486bdeafc9f7ca95028cf6a911a16b1d756efd58 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.891-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46ca148b92dbd833d01a4b8f8fc15411f1084b3663658f212a4acd1ae72f868e |
|
MD5 | 43f5353b09549ecf788eef96860eba11 |
|
BLAKE2b-256 | 99e64d2013debd3ab823ef65065629431b9808b4706fbd29808bda9a19775d67 |