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.563.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d8a4465792aae5e4ea12e6984b68ee937b928c18cc2d06591d5efec40a07332a |
|
MD5 | 671d8520cbf5dfa8dd8619cb791dc08a |
|
BLAKE2b-256 | b576ba205c2a62dfbd0206b696f6f9d2ec703cb2885d2a028d9994f8e5504e66 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.563-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8dc46eb70c5f580c37daeca241827244b248b86ab124758f2a144528af2b2dde |
|
MD5 | 74c267dea3174afff060d3f9830861b4 |
|
BLAKE2b-256 | 2e9019ef20fc964de535a1332f4e21ce38074e8d170c61deefa8176bd8cfe41d |