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.649.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 310754950635555b2ef89e96866bde89a80e4e5d6418f2a529833958f5e760f9 |
|
MD5 | 2026e3c819348c7006d65b79bcc96256 |
|
BLAKE2b-256 | 850d6f07314df2f3f8e81ba536103115db10061c223c3bc7858b53007b1f9092 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.649-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95d40e8d4c090931b2acbcd3dd74112bd9ba4ddc0d0e8db33cf03ec72d48a524 |
|
MD5 | bb39a4e9c59dc4ecba1685603e5f529b |
|
BLAKE2b-256 | 5b2e72a60f191b2abb75dfb6f5be27ed4ca8822c083852aaae441963adc37a72 |