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.577.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1d69df0f7b6f26845261be644d5f9d07f35b113b5a5d0ff2208d613136b907ae |
|
MD5 | 684f3a6c991378e81d6ba3ab43097c04 |
|
BLAKE2b-256 | 39569251f5fbac75a4bbfda88838241735ca6869a2edbdfe423ec4437d657fca |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.577-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c6a7e7b02aa42a9e3d2bea9624fd36e12139c4a6e36c274663155df6fdb7171 |
|
MD5 | 9e3cf454da6a557ab43f736c72e30526 |
|
BLAKE2b-256 | 1f9c057117e827224e8f0420507fd5a8630823f14aa71beef9a37a419afd2d27 |