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.193.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 536a50152c0253c7fcc940ffc6c17ae6421aaf9496ce35c61128cddaf6a4aeac |
|
MD5 | 15cd8648e8489a2d36f7bf7a0d68ebe0 |
|
BLAKE2b-256 | 70735a4ad13efe85a98e785c19f97bff8c06ac25d415dd72fbf633ba687a4685 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.193-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d63164b5881a0187b04e7e922c5076bfdbd0ac2372e099f601e667c37066893 |
|
MD5 | d9f2152b74a36d4720b1d7c03817f486 |
|
BLAKE2b-256 | b6cb9c1884e466346ce13e5c692fda85329fe14dae384a0bea574dbf2ef9cb1e |