# easy-api-node-tpl

**Repository Path**: zangzhihong/easy-api-tpl

## Basic Information

- **Project Name**: easy-api-node-tpl
- **Description**: 轻量简洁的node框架，通过适配器支持同一套代码运行到云函数node环境,bun。。。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-08-31
- **Last Updated**: 2026-06-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# easy-api-tpl

一个轻量简洁(≈10k)的 API 开发框架，更简洁优雅实现易于维护的业务功能，并且通过适配器可同时运行到 serverless , node , bun 等js运行环境。

## 特性
- **ts支持**：完整ts类型支持，通过宏定义`defineService`包裹业务方法，传入的参数自动校验且支持ts语法提示
- **目录结构即路由**：根据目录划分模块，自动生成路由，并根据业务schema描述自动生成接口文档，减少大量样板代码，工程干净整洁。
- **接口描述**：支持对接口进行详细描述，通过schema定义接口参数和返回结果，实现参数验证并支持ts语法提示，并生成最权威的接口文档。
- **灵活配置**：可以定义请求方法、拦截器和错误处理，也可以通过中间件实现更多扩展功能。
- **参数验证**：支持对查询参数、路径参数、请求体进行定义。
###
gitee文档地址：https://gitee.com/zangzhihong/easy-api
github地址：https://github.com/zangzhihong/easy-api