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.727.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7cf6835175a224cd436deee568e498911636775e591a347ef9c4a02e4516cac1 |
|
MD5 | e80c32ec2c58bc8405120852dc988f51 |
|
BLAKE2b-256 | 32bb21a561e7d383d53ac2cbaece68fc353fc9a64eb97d85238b63e534eff311 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.727-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6d22458cfbdb9f224a3ad2fd109282e53066e21e1e134dca9af2f0d4dfc810c |
|
MD5 | 5fef66a0f44d88d5039c8b1737dec539 |
|
BLAKE2b-256 | 71987ee42952279504b600b29cc22743bf0f7f4cf96cf2f871d7ca52bbe5c317 |