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.764.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a6cb6feb4dfc225e5fde6f3492ed5f2629ff5affc5162c30e552b86ffa21beae |
|
MD5 | 6b5b0b3563e978baf8ab0cbb35eb3011 |
|
BLAKE2b-256 | 0a9ea4e637873b2b7cc8f5fdc17510a7139d41288fb55dc72ddebe1b00367089 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.764-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2ec3d0ca074d09a801340d5cc03b3be8cdf3af46fa253b07fd1168a4b3c440d |
|
MD5 | e2ed520340e46e41f2e57306509eff11 |
|
BLAKE2b-256 | 924c1d25b2717ff3c335bfc6c4558ce2104a9d0839e3f4f37e4d90156b438b80 |