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.844.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6c529553bbc3756d035f868818024a94c88ac86c93c795f03dfc913d5ee1721 |
|
MD5 | c3dfb66a1597b3745e1c4c2fdda2a6a5 |
|
BLAKE2b-256 | 5d2f167b292cfed724ed7883e3b35f6a158eacf9acb3d0904e0d839c0384a6a0 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.844-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 928c712659169d9a53f5f8ddc1e3763ec42a6f416c6c3ab9738ffca58f3f602e |
|
MD5 | 1ed44171c441d2fe224acf78502816f3 |
|
BLAKE2b-256 | ae90a8a39bbc05ba2e8c548f33d039dae14aa4f5b3cb9edc68287ac15bf576e7 |