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.446.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | becbd5d21a2d3377dab1aafc0d5b9863c4709d22f130f2cc2e1f2641a88d6c48 |
|
MD5 | 6d77c144fda6d2f403613dd941e23515 |
|
BLAKE2b-256 | 702ea93f4d69dc2881b9816607d538d39eccf903b7165a6f48f7d4b895644d4e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.446-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e7e4d0012c14baa379d22d9f1072b0678b349602e148a172d22087073744032 |
|
MD5 | 47345f8fc499cae5f5e4a4d4dcaa6f29 |
|
BLAKE2b-256 | 00b6fa32ff7b5413d8ef9e616953a7a25101c83cedf9c63ad411ef6ea113c6e6 |