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.159.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ccf26b1c7c0a5f1bf60983c8e4f666db8dc4694f2bbaec025e1aa0915ebcdb8 |
|
MD5 | 6c4d25232c43ff9f1c36064d2610ad16 |
|
BLAKE2b-256 | d0b61720fd94471e39ac544aa312eb47cc468ddf5a89681f76239f30301ad688 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.159-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe8674d9c6d995ba69e71ab880f3bc9371b245c84c850f4be3cd1e40fd6063f5 |
|
MD5 | 9acaf664b35dfe59b30d536d9f7d7820 |
|
BLAKE2b-256 | a1fd460423755de5671644a351222c1ebb4b965b618e263d35b11582bad04cd5 |