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.397.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d28895522b1093f5480355e3f26a352339565b35040a4cd56669c202b8bd6c49 |
|
MD5 | c0d87113fc6c982fc52fb3ed5224771f |
|
BLAKE2b-256 | 5c5a1dcf29fed54800dcada79e7bfbcc8bcd059d2a5529ad4d63471d5d0f4b33 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.397-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16f066e39a61237c26c76cbaebbdad6e1df8183d516080651af489be7dc3bf88 |
|
MD5 | 28f1f22fc4ef315403bd71b935c04be6 |
|
BLAKE2b-256 | 4555f4d9e36f67bb4078cd07fe6ba77b250988747141e637911537565b8999a1 |