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.309.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25af825cc0f97073bd04893ad73b42ede50dc23c26c1ca9e41dbab073d2935aa |
|
MD5 | be9e6fc575a95a004d2a67903996bcb8 |
|
BLAKE2b-256 | 3114feec981887ed367784fcceaaf6f7c2e53eaf5389dd49d901c4943a160818 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.309-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5e2fbfe44a14f2fbda5e45ded4e48b3157596477585cf25519f696a85801d2e |
|
MD5 | c5689e124521a4e7941e31847e93521e |
|
BLAKE2b-256 | 676bd43e580aecc247e8d85c330e6dfdb6ccf126908f6ce61fd239b2bfda173f |