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.178.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 74336f279cc00894c335b88c647eb792db6fcb26e263856fa2050fc93b7aea91 |
|
MD5 | 23f08d1a00d87c671e97de0a08d61335 |
|
BLAKE2b-256 | 5ecc0280d7aa8abbb5f28579e5971629bfd2066ac73dd82cdf9a32b1d0e12007 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.178-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ab25df5baf648c5346711d91d6256cafc0905a11c8ef7c5040fc99acf73ee09 |
|
MD5 | b69187f8e43545a69edae35cae1794b8 |
|
BLAKE2b-256 | fe5e3f21d0d2495e3341919f5edf405be0b55f4dfb7fd118a018c3781e17dfb2 |