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.292.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | eed5a92d7972a471d359254bae4ef13c073ff43b2c14b3176eb04d7d0ab1d6dd |
|
MD5 | e7198b18753cf346059d75baeb89e9fb |
|
BLAKE2b-256 | faf3ef384d50df4fd556839a867de303a6bee6a76d2a346b9a71f6a76eb77f54 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.292-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cc53db146d04b5a9a8500e7854ec6999bace28e8a4f51e4166114e2d3398dff |
|
MD5 | 03a5dbceda3be62bb01a40bf4ab153c8 |
|
BLAKE2b-256 | 229c675cc8388cdad9b8fe4e63bfb89106d6769b3304ab014e7e134f8a996ccd |