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.393.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4129352b92c8f9e38fa6ddb88c6aed667f180af30a2a002b39d4dd748e61fa51 |
|
MD5 | 21a2b0c0ac6be62f588bfd36d6b41876 |
|
BLAKE2b-256 | f3018bc1e272b595dc26c13296aeae451bb088120b1a1d110ca540ef346cb385 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.393-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 49517e0dccd29ccdbbf4acdc3ff0f04b5fd245e7c4f1c471e7a8d49d9af00960 |
|
MD5 | b575cd5468138285fcb19ae6e1cccdde |
|
BLAKE2b-256 | 5b400f21eb3b765343add133dd2b4188a068c6d15e3913b531a721d6f847828d |