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.319.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c08139369e7750ad122e9c2fa0e7c68eb084973662dd72293f1c39e86bf9ccc3 |
|
MD5 | 018a2e214b6c7220f4f1e2414855a8e8 |
|
BLAKE2b-256 | 2bd0b1571739945e64003b394250392a826ad961502f8fba7c97b1a0acef3f67 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.319-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7e003d8df57f1a7549ae51172834a9268660000d2ed0f9c582d5bf79c4a0ff9 |
|
MD5 | 40a40b3a95ed2cbbf58b42eb1c236e38 |
|
BLAKE2b-256 | 14c3eb9c5dda9a9a055496b149c01c14534d619d9bc8ea242912c2032adeeda5 |