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.75.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25b597a816b9f4642046e2eca07eb34566228e0a7ddc0ace0395d66553a7084e |
|
MD5 | aa21e75964c9dff73ac7e9d697ec0319 |
|
BLAKE2b-256 | 499ba2e1c6e394ee9a4e0a5b93e7fd4acc0740cb13ab93b59beef1642d8b9fa2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.75-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e76a17e49a8be2e08528ec5224d4f6049d0188f43fd92b372bbde5635637d40f |
|
MD5 | 3d85c1b989a0d2b93a58497302bed767 |
|
BLAKE2b-256 | 64aa301d78118aa9c7290dc571f844b5530a5459597b18a18b9d11dd300987d4 |