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.638.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dde86a5d9b744387fbba3e3b4524935e1f5800cfebf78f6c4562445be83f0c4 |
|
MD5 | d9e995ae2e611532d0ac0727bd89d5e1 |
|
BLAKE2b-256 | 1f46a6a2595a3fd9b326c9228dc7ee0af7074d5e9a4ab6aef3434bbc0d4f352c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.638-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 390116d474a938148abfe60c445d0b45c70d245792a3515bc733997133980795 |
|
MD5 | 17bb75951e94f2a0bc2de33b302b69eb |
|
BLAKE2b-256 | 0c99ec6a4c61a0749063db4b692c28f23ee3ec253f07e7dd20c9e8442e34f015 |