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.457.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3805d457e47430f8563bdc1b27ee42ec1b25e86a725b96b96ff0935ebeb02920 |
|
MD5 | f2844f2d36db95ff6ef989d688e6f4b0 |
|
BLAKE2b-256 | c2ed4a252a30bcfcaac60195d21315bed1f84c0da5ecacbd0ab6331186b73d9a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.457-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88aa7e1ea43e7ceadda6adb6017b0cd46505f6904affcd2b457d70d1217fc923 |
|
MD5 | ef8dd5956d74e1ea374668f4f916b523 |
|
BLAKE2b-256 | 2fea68b42a92732b1bbdd7b7121ec9c61af756ad2fa79651e086e64ff689ea04 |