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.690.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95479520a8d5c9a21f90c6b90c04d43e99ee6af8901086a138f38ad70ffcd399 |
|
MD5 | 67c652acfec34f97bca09efdd12b1411 |
|
BLAKE2b-256 | 50fbc469fa95c113f4d23046eed90451cb8bba7967c4369613ba3927ccfc66ed |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.690-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc1c965c211ad41e80d9a0eb1a18f23337dd84ab1c2b36f65e138396e67e7ae6 |
|
MD5 | 83ae10593d2b8a0165d316d5468db3ad |
|
BLAKE2b-256 | e14ba01d386f905ab704aa11ffce5c7888e6c02d1cb0bca438ee94b7b82fd9dc |