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.536.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fe5ea6c70a0496d78901fc67d94cb6371aa9c75d631f9a2f1a8a52254f2cd00 |
|
MD5 | 52402b199fd2213324484c763ad607e8 |
|
BLAKE2b-256 | 188af5fc0c19df1e9ebd04ed0346607139d3a8ca6a12f24e78d35271a9cc059b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.536-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77628bf8cd801483467af246834e3336f1cbc7e05f0ffefecba15ba167f3b011 |
|
MD5 | 934f1e58d9068853a1ed7394c41cb0b5 |
|
BLAKE2b-256 | a3ccdedf21c2fec6e71f4144c64c6ea813c84f04972f33a4395c6ea3ee6be765 |