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.508.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0efe5c05f1072ba3bfb0ff851ee04fd9dc383f4980a9f57120a9df3b2e7d4fa |
|
MD5 | 0cdb56c71de1a267f26e59fd9bfc65e1 |
|
BLAKE2b-256 | 51fc30bd816d648dc31ee5fa105acea114f169873b7a56f91dff371c0a6a186a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.508-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b9fc097ba1a20c862a98ba662dc735b168b46826b62a5857aee16940ef4f3be |
|
MD5 | 8b60e662f3d3eb1919baa7825c3d57de |
|
BLAKE2b-256 | a59c4a2765cf622bbf1863f6b9e51b62ae7b4f653d13788544403e63448a8355 |