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.629.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 924a25840662deb107d99c97b9e8f143d9c3f6154e42a1c4b84e437c46bf3d95 |
|
MD5 | 55015102c2bb22e197ee0a34eec5cc6d |
|
BLAKE2b-256 | 0fee3befa9c203b6760546053f941e08af6a4f3223601b385679c2d6ed59e2ab |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.629-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 40caf481c7023e3ac2b6f0cd6cadc70547e3fb84dd630cbac8c64584ca2e1193 |
|
MD5 | 2c3a1bf2d345f1c34788b0e756e2e9b2 |
|
BLAKE2b-256 | a43db8cfbe5b600b7c789397424be83796386c7b216bafa21a53c144209f4c70 |