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.925.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c6b25e9700409e968b6edcaeb40be32ed2f91216530e6ecb92c525eab4824fe4 |
|
MD5 | 07164ab8be083f8ad681945888dc0fc3 |
|
BLAKE2b-256 | de44007f80e6bdddc01d90a323eceeaf885d62fe00a359add69ad7449e538df8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.925-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c537ecc758b06826a4c691b9ad1e4d514fb76609f40889260af62266fb3befc |
|
MD5 | d7523532d4f953c9aa13b188b2c60b93 |
|
BLAKE2b-256 | adb65fa198397010e5f7d085e150cdb8c912032ed8eacd0825f2a1e26719afe4 |