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.903.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14b3793de691256473b83c786c586ae62142d3f5802902fe593a6b2371857b9a |
|
MD5 | 6d5261c0d727e5776fbedf718056966e |
|
BLAKE2b-256 | b1276cdfa05a21b4667176325c48d4ca504ed1f2e71a05fdc8829b32f46d8abb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.903-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 270f4c62aa53d26da5c06436bc499d85649c90eda499cb01831c198fcf3596d0 |
|
MD5 | 1a4ee3eaa3ca0f018f4e0549c6fc4550 |
|
BLAKE2b-256 | de4fd00ec6fe995815eb13f4d0f2fa924f21a9b0005bc5f2cb50729dc23629ae |