${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass SchemaManager
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new
Schema Manager(options?): SchemaManager Parameters
Optionaloptions: SchemaManagerOptions
Returns SchemaManager
Properties
Protected Readonly map
Protected Readonly options
Readonly type
Accessors
is
- get isAbortEarly(): boolean
Returns boolean
Methods
base
- base
Type Value(type, isArray, input, params, format?): ISchemaCheckResult 检查指定基本类型并返回值
-Parameters
type: string
名称
-isArray: boolean
是否为数组
-input: any
输入值
-params: any
类型参数
-Optionalformat: boolean是否格式化
-
Returns ISchemaCheckResult
create
- create(fields, name?): SchemaType
创建Schema但不自动注册
-Parameters
fields: ISchemaTypeFields
字段信息
-Optionalname: stringSchema名称
-
Returns SchemaType
for
- for
Each(iter): void 遍历类型
-Parameters
iter: ((value, key, map) => void)
迭代函数
-- (value, key, map): void
Parameters
value: SchemaType
key: string
map: Map<string, SchemaType>
Returns void
Returns void
get
- get(type): SchemaType
获取指定Schema
-Parameters
type: string
名称
-
Returns SchemaType
has
register
- register(name, fields): this
注册Schema
-Parameters
name: string
名称
-fields: ISchemaTypeFields
字段具体信息
-
Returns this
value
- value(type, input): ISchemaCheckResult
检查指定Schema并返回值
-Parameters
type: string
名称
-input: any
输入值
-
Returns ISchemaCheckResult
Generated using TypeDoc
Class SchemaType
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Schema Type(manager, fields, name?): SchemaType Parameters
manager: SchemaManager
fields: ISchemaTypeFields
Optionalname: string
Returns SchemaType
Properties
Protected Readonly fields
Protected manager
Readonly name
name: string
Methods
partial
- partial(): SchemaType
从当前Schema获取所有字段为可选的新Schema
-Returns SchemaType
pick
- pick(...fieldNames): SchemaType
从当前Schema获取仅包含指定字段的新Schema
-Parameters
Rest...fieldNames: string[]
Returns SchemaType
required
- required(): SchemaType
从当前Schema获取所有字段为必填的新Schema
-Returns SchemaType
swagger
value
- value(input, isArray?): ISchemaCheckResult
检查Schema并返回值
-Parameters
input: any
OptionalisArray: boolean
Returns ISchemaCheckResult
Generated using TypeDoc
Class ValueTypeItem
Constructors
constructor
- new
Value Type Item(options): ValueTypeItem Parameters
options: IValueTypeOptions
Returns ValueTypeItem
Properties
Protected Readonly options
Accessors
info
- get info(): IValueTypeOptions
类型信息
-Returns IValueTypeOptions
Methods
check
- check(input, params?): IValueTypeCheckResult
检查参数是否合法
-Parameters
input: any
输入值
-Optionalparams: any类型选项
-
Returns IValueTypeCheckResult
format
parse
value
- value(input, params?, format?): IValueResult
检查参数，如果参数默认开启格式化，则格式化 -检查流程： -1: 解析 parse -2: 检查 check -3?: 格式化 formatter
-Parameters
input: any
输入的值
-Optionalparams: any类型选项
-Optionalformat: boolean是否格式化，如果为undefined则使用默认配置
-
Returns IValueResult
Generated using TypeDoc
Class ValueTypeManager
Constructors
constructor
- new
Value Type Manager(options?): ValueTypeManager Parameters
Optionaloptions: ValueTypeManagerOptions
Returns ValueTypeManager
Properties
Protected Readonly map
Protected Readonly options
Methods
for
- for
Each(iter): void 遍历类型
-Parameters
iter: ((value, key, map) => void)
迭代函数
-- (value, key, map): void
Parameters
value: ValueTypeItem
key: string
map: Map<string, ValueTypeItem>
Returns void
Returns void
get
- get(type): ValueTypeItem
获取指定类型
-Parameters
type: string
类型名称
-
Returns ValueTypeItem
has
register
- register(type, options): this
注册类型
-Parameters
type: string
类型名称
-options: IValueTypeOptions
选项
-
Returns this
value
- value(type, input, params?, format?): IValueResult
获取指定类型值
-Parameters
type: string
类型名称
-input: any
输入值
-Optionalparams: any类型参数
-Optionalformat: boolean是否格式化
-
Returns IValueResult
Generated using TypeDoc
Class default<T>
Easy rest api helper
-Type Parameters
T = DEFAULT_HANDLER
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
- new default<T>(options): default<T>
Type Parameters
T = DEFAULT_HANDLER
Parameters
options: IApiOption
Returns default<T>
Properties
Private api
Private app
app: any
Private config
config: IAPIConfig
Private defineAPI
Private docs
Private error
error: {
internalError: ((msg) => Error);
invalidParameter: ((msg) => Error);
missingParameter: ((msg) => Error);
}
internalError: ((msg) => Error);
invalidParameter: ((msg) => Error);
missingParameter: ((msg) => Error);
}
Type declaration
internal
Error: ((msg) => Error) - (msg): Error
Parameters
msg: string
Returns Error
invalid
Parameter: ((msg) => Error) - (msg): Error
Parameters
msg: string
Returns Error
missing
Parameter: ((msg) => Error) - (msg): Error
Parameters
msg: string
Returns Error
Private error
error
Private force
force
Private group
Private groups
groups: Record<string, string>
Private info
Private Optional mock
Private registAPI
Private schema
Optional share
share
Private test
test
Private type
utils
utils: __module = utils
Accessors
api
errors
- get errors(): ErrorManager
错误列表
-Returns ErrorManager
private
- get privateInfo(): {
app: any;
docsOptions: IDocOptions;
error: {
internalError: ((msg) => Error);
invalidParameter: ((msg) => Error);
missingParameter: ((msg) => Error);
};
groupInfo: Record<string, IGroupInfo<T>>;
groups: Record<string, string>;
info: IApiOptionInfo;
mockHandler: undefined | ((data) => T);
} 获取私有变量信息
-Returns {
app: any;
docsOptions: IDocOptions;
error: {
internalError: ((msg) => Error);
invalidParameter: ((msg) => Error);
missingParameter: ((msg) => Error);
};
groupInfo: Record<string, IGroupInfo<T>>;
groups: Record<string, string>;
info: IApiOptionInfo;
mockHandler: undefined | ((data) => T);
}app: any
docs
Options: IDocOptions error: {
internalError: ((msg) => Error);
invalidParameter: ((msg) => Error);
missingParameter: ((msg) => Error);
}internal
Error: ((msg) => Error) - (msg): Error
Parameters
msg: string
Returns Error
invalid
Parameter: ((msg) => Error) - (msg): Error
Parameters
msg: string
Returns Error
missing
Parameter: ((msg) => Error) - (msg): Error
Parameters
msg: string
Returns Error
group
Info: Record<string, IGroupInfo<T>> groups: Record<string, string>
info: IApiOptionInfo
mock
Handler: undefined | ((data) => T)
schema
- get schema(): SchemaManager
类型列表
-Returns SchemaManager
test
- get test(): default
测试实例
-Returns default
type
- get type(): ValueTypeManager
类型列表
-Returns ValueTypeManager
Methods
add
after
- after
Hooks(fn): void 设置全局 After Hook
-Parameters
fn: T
Returns void
api
- api
Checker(): ((schema, params?, query?, body?) => Record<string, any>) 获取Schema检查实例
-Returns ((schema, params?, query?, body?) => Record<string, any>)
- (schema, params?, query?, body?): Record<string, any>
Parameters
schema: default<any>
Optionalparams: Record<string, any>Optionalquery: Record<string, any>Optionalbody: Record<string, any>
Returns Record<string, any>
before
- before
Hooks(fn): void 设置全局 Before Hook
-Parameters
fn: T
Returns void
bind
- bind
Router(router, checker): void 绑定路由 +
default | erest Class default<T>
Easy rest api helper
+Type Parameters
- T = DEFAULT_HANDLER
Index
Constructors
Properties
Accessors
Methods
addDoc Plugin +after Hooks +api Params Check +before Hooks +bind Koa Router To App +bind Router +bind Router To App +build Swagger +checker Express +checker Koa +checker Lei Web +create Schema +gen Docs +group +init Test +params Checker +response Checker +schema Checker +set Doc Output Foramt +set Doc Writter +set Format Output +set Mock Handler + Accessors
api
errors
- get errors(): ErrorManager
错误列表
+Returns ErrorManager
private
Info - get privateInfo(): {
app: unknown;
docsOptions: IDocOptions;
error: {
internalError: (msg: string) => Error;
invalidParameter: (msg: string) => Error;
missingParameter: (msg: string) => Error;
};
groupInfo: Record<string, IGroupInfo<T>>;
groups: Record<string, string>;
info: IApiOptionInfo;
mockHandler: undefined | ((data: unknown) => T);
}获取私有变量信息
+Returns {
app: unknown;
docsOptions: IDocOptions;
error: {
internalError: (msg: string) => Error;
invalidParameter: (msg: string) => Error;
missingParameter: (msg: string) => Error;
};
groupInfo: Record<string, IGroupInfo<T>>;
groups: Record<string, string>;
info: IApiOptionInfo;
mockHandler: undefined | ((data: unknown) => T);
}
schema
- get schema(): {
check: (name: string, value: unknown) => boolean;
createZodSchema: (schemaType: ISchemaType) => ZodType;
get: (
name: string,
) =>
| undefined
| ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
has: (name: string) => boolean;
register: (name: string, schema: ZodType) => void;
}Schema 管理器
+Returns {
check: (name: string, value: unknown) => boolean;
createZodSchema: (schemaType: ISchemaType) => ZodType;
get: (
name: string,
) =>
| undefined
| ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
has: (name: string) => boolean;
register: (name: string, schema: ZodType) => void;
}
test
- get test(): IAPITest
测试实例
+Returns IAPITest
type
- get type(): {
get: (
name: string,
) =>
| undefined
| ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
has: (name: string) => boolean;
register: (name: string, schema: ZodType) => default<T>;
value: (
type: string,
input: unknown,
params?: unknown,
format?: boolean,
) => { message: string; ok: boolean; value: unknown };
}类型管理器
+Returns {
get: (
name: string,
) =>
| undefined
| ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>;
has: (name: string) => boolean;
register: (name: string, schema: ZodType) => default<T>;
value: (
type: string,
input: unknown,
params?: unknown,
format?: boolean,
) => { message: string; ok: boolean; value: unknown };
}
Methods
add
Doc Plugin 注册文档生成组件
+Parameters
- name: string
- plugin: IDocGeneratePlugin
Returns void
after
Hooks api
Params Check 获取API参数检查实例
+Returns (data: unknown, schema: Record<string, ISchemaType>) => Record<string, unknown>
before
Hooks bind
Koa Router To App bind
Router 绑定路由 （加载顺序：beforeHooks -> apiCheckParams -> middlewares -> handler -> afterHooks ）
-Parameters
Returns void
bind
Router To App build
Swagger checker
Express checker
Lei Web - checker
Lei Web<K>(ereat, schema): ((ctx) => void) Type Parameters
Parameters
ereat: default<T>
schema: default<DEFAULT_HANDLER>
Returns ((ctx) => void)
- (ctx): void
Parameters
ctx: K
Returns void
gen
Docs group
init
Test params
Checker response
Checker - response
Checker(): ((data, schema) => IValueResult | ISchemaCheckResult) 返回结果检查
-Returns ((data, schema) => IValueResult | ISchemaCheckResult)
- (data, schema): IValueResult | ISchemaCheckResult
Parameters
data: any
schema: SchemaType | ISchemaType | Record<string, ISchemaType>
Returns IValueResult | ISchemaCheckResult
schema
Checker set
Doc Output Foramt set
Doc Writter set
Format Output set
Mock Handler - checker
\ No newline at end of file +Generated using TypeDoc
Returns void
bind
build
获取Swagger信息
+Returns unknown
checker
checker
checker
create
- createSchema(
schemaObj: Record<string, ISchemaType>,
): ZodObject<
{
[key: string]: ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
$strip,
>创建 Schema 对象
+Parameters
- schemaObj: Record<string, ISchemaType>
Returns ZodObject<
{
[key: string]: ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
$strip,
>
gen
生成文档
+Parameters
- savePath: string = ...
文档保存路径
+ - onExit: boolean = true
是否等待程序退出再保存
+
Returns void
- savePath: string = ...
group
init
初始化测试系统
+Parameters
- app: unknown
APP或者serve实例，用于init supertest
+ - testPath: string = ...
测试文件路径
+ - docPath: string = ...
输出文件路径
+
Returns void
- app: unknown
params
获取参数检查实例
+Returns (name: string, value: unknown, schema: ISchemaType) => unknown
response
- responseChecker(): (
data: unknown,
schema: ISchemaType,
) =>
| Record<string, unknown>
| { message: string; ok: boolean; value: unknown }Returns (
data: unknown,
schema: ISchemaType,
) =>
| Record<string, unknown>
| { message: string; ok: boolean; value: unknown }
schema
- schemaChecker(): (
data: unknown,
schema: Record<string, ISchemaType>,
requiredOneOf?: string[],
) => Record<string, unknown>获取Schema检查实例
+Returns (
data: unknown,
schema: Record<string, ISchemaType>,
requiredOneOf?: string[],
) => Record<string, unknown>
set
设置文档格式化函数
+Parameters
- fn: (out: unknown) => unknown
Returns void
set
设置文档格式化函数
+Parameters
- fn: IDocWritter
Returns void
set
设置测试格式化函数
+Parameters
- fn: (out: unknown) => [null | Error, unknown]
Returns void
set
Parameters
- fn: (data: unknown) => T
Returns void
Function apiParamsCheck
- apiParamsCheck(
ctx: default<unknown>,
schema: API<unknown>,
params?: Record<string, unknown>,
query?: Record<string, unknown>,
body?: Record<string, unknown>,
headers?: Record<string, unknown>,
): Record<string, unknown>API 参数检查
+Parameters
- ctx: default<unknown>
- schema: API<unknown>
Optionalparams: Record<string, unknown>Optionalquery: Record<string, unknown>Optionalbody: Record<string, unknown>Optionalheaders: Record<string, unknown>
Returns Record<string, unknown>
Function createZodSchema
Parameters
- typeInfo: string | ISchemaType
Returns ZodType
Function isISchemaType
Function isISchemaTypeRecord
diff --git a/docs/functions/paramsChecker.html b/docs/functions/paramsChecker.html
new file mode 100644
index 0000000..657495f
--- /dev/null
+++ b/docs/functions/paramsChecker.html
@@ -0,0 +1 @@
+
Function paramsChecker
- paramsChecker(
ctx: default<unknown>,
name: string,
input: unknown,
typeInfo: ISchemaType,
): unknownParameters
- ctx: default<unknown>
- name: string
- input: unknown
- typeInfo: ISchemaType
Returns unknown
Generated using TypeDoc
Function responseChecker
- responseChecker<T extends Record<string, unknown>>(
_ctx: default<unknown>,
data: T,
schema: ISchemaType | Record<string, ISchemaType> | SchemaType<unknown>,
): T | { message: string; ok: boolean; value: unknown }Type Parameters
- T extends Record<string, unknown>
Parameters
- _ctx: default<unknown>
- data: T
- schema: ISchemaType | Record<string, ISchemaType> | SchemaType<unknown>
Returns T | { message: string; ok: boolean; value: unknown }
Function schemaChecker
- schemaChecker<T extends Record<string, unknown>>(
ctx: default<unknown>,
data: T,
schema: Record<string, ISchemaType> | SchemaType<unknown>,
requiredOneOf?: string[],
): Record<string, unknown>Type Parameters
- T extends Record<string, unknown>
Parameters
- ctx: default<unknown>
- data: T
- schema: Record<string, ISchemaType> | SchemaType<unknown>
- requiredOneOf: string[] = []
Returns Record<string, unknown>
Generated using TypeDoc
erest
-
-
-
-
-
-
-
node-erest
通过简单的方式构建一个优秀的 API 服务（基于 express、@leizm/web 等）。
-一个优秀的 API 必须要有优秀的文档、较完整的测试，同时便于开发部署与联调。在文档方面，最大的问题在于，随着 API 的发展需要找人同步更新文档。有个更好的方案是不脱离代码自更新文档。
-通过 ERest，你可以在定义 API 的同时，完成参数模型的定义、API格式的定义，同时生成便于写 API 测试的脚手架，像调用本地方法一样写 API 测试，并自动完成 API 文档的生成（包括示例数据），同时生成 Swagger、Postman、基于 axios 的 js-sdk（更多功能支持自定义）。
-使用 (generator-erest)[https://github.com/yourtion/node-generator-erest] 帮助你快速生成一个 API 项目框架。
-Install
$ npm install erest --save
-Use yeoman generator
$ npm install generator-erest -g
# Express
$ yo erest:express
# @leizm/web
$ yo erest:lei-web
-How to use
'use strict';
const API = require('erest').default;
// API info for document
const INFO = {
title: 'erest-demo',
description: 'Easy to write, easy to test, easy to generate document.',
version: new Date(),
host: 'http://127.0.0.1:3000',
basePath: '/api',
};
// API group info
const GROUPS = {
Index: '首页',
};
// Init API
const apiService = new API({
info: INFO,
groups: GROUPS,
});
apiService.api.get('/index')
.group('Index')
.title('Test api')
.register((req, res) => {
res.end('Hello, API Framework Index');
});
const express = require('express');
const app = express();
const router = new express.Router();
app.use('/api', router);
// bing express router
apiService.bindRouter(router, apiService.checkerExpress);
app.listen(3000, function () {
console.log('erest-demo listening started');
});
-Generated using TypeDoc
erest
 + + + + + + +
+ERest
🚀 现代化的 TypeScript API 框架 - 通过简单的方式构建优秀的 API 服务
+基于 Express、@leizm/web 等主流框架，ERest 提供了一套完整的 API 开发解决方案。支持自动文档生成、类型安全验证、测试脚手架等功能，让 API 开发更加高效和可靠。
+✨ 核心特性
-
+
-
+
🔷 TypeScript 原生支持 - 完整的类型推导和类型安全
+
+ -
+
🔧 原生 Zod 集成 - 高性能的参数验证和类型推导
+
+ -
+
📚 自动文档生成 - 支持 Swagger、Postman、Markdown 等多种格式
+
+ -
+
🧪 测试脚手架 - 像调用本地方法一样编写 API 测试
+
+ -
+
🔌 多框架支持 - 兼容 Express、Koa、@leizm/web 等主流框架
+
+ -
+
📦 SDK 自动生成 - 自动生成基于 axios 的客户端 SDK
+
+ -
+
🎯 零配置启动 - 开箱即用的开发体验
+
+
🛠️ 技术栈
-
+
-
+
语言: TypeScript 5.8+
+
+ -
+
运行时: Node.js 18+
+
+ -
+
验证库: Zod 4.0+
+
+ -
+
支持框架: Express 4.x, Koa 3.x, @leizm/web 2.x
+
+ -
+
构建工具: Vite, Biome
+
+ -
+
测试框架: Vitest
+
+
📦 安装
# npm
npm install erest
# yarn
yarn add erest
# pnpm
pnpm add erest
+快速开始脚手架
使用 快速生成项目框架：
+npm install generator-erest -g
# Express 项目
yo erest:express
# @leizm/web 项目
yo erest:lei-web
+🚀 快速开始
基础用法
import ERest, { z } from 'erest';
import express from 'express';
// 创建 ERest 实例
const api = new ERest({
info: {
title: 'My API',
description: 'A powerful API built with ERest',
version: new Date(),
host: 'http://localhost:3000',
basePath: '/api',
},
groups: {
user: '用户管理',
post: '文章管理',
},
});
// 定义 API 接口
api.api.get('/users/:id')
.group('user')
.title('获取用户信息')
.params(z.object({
id: z.string().describe('用户ID'),
}))
.query(z.object({
include: z.string().optional().describe('包含的关联数据'),
}))
.register(async (req, res) => {
const { id } = req.params;
const { include } = req.query;
// 业务逻辑
const user = await getUserById(id, include);
res.json({ success: true, data: user });
});
// 绑定到 Express
const app = express();
const router = express.Router();
app.use('/api', router);
api.bindRouter(router, api.checkerExpress);
app.listen(3000, () => {
console.log('🚀 Server running on http://localhost:3000');
});
+原生 Zod 类型支持
import { z } from 'erest';
// 定义复杂的数据模型
const CreateUserSchema = z.object({
name: z.string().min(1).max(50),
email: z.string().email(),
age: z.number().int().min(18).max(120),
tags: z.array(z.string()).optional(),
profile: z.object({
bio: z.string().optional(),
avatar: z.string().url().optional(),
}).optional(),
});
api.api.post('/users')
.group('user')
.title('创建用户')
.body(CreateUserSchema)
.register(async (req, res) => {
// req.body 自动获得完整的类型推导
const userData = req.body; // 类型安全！
const user = await createUser(userData);
res.json({ success: true, data: user });
});
+自动文档生成
// 生成多种格式的文档
api.docs.generateDocs({
swagger: './docs/swagger.json',
markdown: './docs/api.md',
postman: './docs/postman.json',
axios: './sdk/api-client.js',
});
+Interface APICommon<T>
interface APICommon<T> {
description?: string;
handler?: T;
method: "delete" | "get" | "patch" | "post" | "put";
path: string;
response?: TYPE_RESPONSE;
title: string;
}
description?: string;
handler?: T;
method: "delete" | "get" | "patch" | "post" | "put";
path: string;
response?: TYPE_RESPONSE;
title: string;
}
Type Parameters
T = DEFAULT_HANDLER
Hierarchy (view full)
- APICommon
Properties
Optional description
description?: string
Optional handler
method
method: "delete" | "get" | "patch" | "post" | "put"
path
path: string
Optional response
title
title: string
Generated using TypeDoc
Interface APICommon<T>
interface APICommon<T = DEFAULT_HANDLER> {
description?: string;
handler?: T;
method: "get" | "post" | "put" | "delete" | "patch";
path: string;
response?: TYPE_RESPONSE;
title: string;
}
description?: string;
handler?: T;
method: "get" | "post" | "put" | "delete" | "patch";
path: string;
response?: TYPE_RESPONSE;
title: string;
}
Type Parameters
- T = DEFAULT_HANDLER
Hierarchy (View Summary)
- APICommon
Interface APIDefine<T>
interface APIDefine<T> {
before?: T[];
body?: Record<string, ISchemaType>;
description?: string;
group?: string;
handler?: T;
headers?: Record<string, ISchemaType>;
method: "delete" | "get" | "patch" | "post" | "put";
middlewares?: T[];
mock?: Record<string, any>;
params?: Record<string, ISchemaType>;
path: string;
query?: Record<string, ISchemaType>;
required?: string[];
requiredOneOf?: string[];
response?: TYPE_RESPONSE;
title: string;
}
before?: T[];
body?: Record<string, ISchemaType>;
description?: string;
group?: string;
handler?: T;
headers?: Record<string, ISchemaType>;
method: "delete" | "get" | "patch" | "post" | "put";
middlewares?: T[];
mock?: Record<string, any>;
params?: Record<string, ISchemaType>;
path: string;
query?: Record<string, ISchemaType>;
required?: string[];
requiredOneOf?: string[];
response?: TYPE_RESPONSE;
title: string;
}
Type Parameters
Hierarchy (view full)
Properties
Optional before
Optional body
body?: Record<string, ISchemaType>
Optional description
description?: string
Optional group
group?: string
Optional handler
Optional headers
headers?: Record<string, ISchemaType>
method
method: "delete" | "get" | "patch" | "post" | "put"
Optional middlewares
Optional mock
mock?: Record<string, any>
Optional params
params?: Record<string, ISchemaType>
path
path: string
Optional query
query?: Record<string, ISchemaType>
Optional required
required?: string[]
Optional required
required
Optional response
title
title: string
Generated using TypeDoc
Interface APIDefine<T>
interface APIDefine<T> {
before?: T[];
body?: Record<string, ISchemaType>;
description?: string;
group?: string;
handler?: T;
headers?: Record<string, ISchemaType>;
method: "get" | "post" | "put" | "delete" | "patch";
middlewares?: T[];
mock?: Record<string, unknown>;
params?: Record<string, ISchemaType>;
path: string;
query?: Record<string, ISchemaType>;
required?: string[];
requiredOneOf?: string[];
response?: TYPE_RESPONSE;
title: string;
}
before?: T[];
body?: Record<string, ISchemaType>;
description?: string;
group?: string;
handler?: T;
headers?: Record<string, ISchemaType>;
method: "get" | "post" | "put" | "delete" | "patch";
middlewares?: T[];
mock?: Record<string, unknown>;
params?: Record<string, ISchemaType>;
path: string;
query?: Record<string, ISchemaType>;
required?: string[];
requiredOneOf?: string[];
response?: TYPE_RESPONSE;
title: string;
}
Type Parameters
- T
Hierarchy (View Summary)
Properties
Optionalbefore
Optionalbody
Optionaldescription
description?: string
Optionalgroup
group?: string
Optionalhandler
Optionalheaders
method
method: "get" | "post" | "put" | "delete" | "patch"
Optionalmiddlewares
Optionalmock
mock?: Record<string, unknown>
Optionalparams
path
path: string
Optionalquery
Optionalrequired
required?: string[]
Optionalrequired
requiredOneOf?: string[]
Optionalresponse
title
title: string
Interface APIOption<T>
interface APIOption<T> {
_allParams: Map<string, ISchemaType>;
beforeHooks: Set<T>;
examples: IExample[];
group: string;
middlewares: Set<T>;
mock?: Record<string, any>;
realPath: string;
required: Set<string>;
requiredOneOf: string[][];
response?: TYPE_RESPONSE;
responseSchema?: SchemaType | ISchemaType;
tested: boolean;
}
_allParams: Map<string, ISchemaType>;
beforeHooks: Set<T>;
examples: IExample[];
group: string;
middlewares: Set<T>;
mock?: Record<string, any>;
realPath: string;
required: Set<string>;
requiredOneOf: string[][];
response?: TYPE_RESPONSE;
responseSchema?: SchemaType | ISchemaType;
tested: boolean;
}
Type Parameters
Hierarchy
- Record<string, any>
- APIOption
Index
Properties
Properties
_all
_all
before
examples
group
group: string
middlewares
Optional mock
mock?: Record<string, any>
real
real
required
required: Set<string>
required
required
Optional response
Optional response
tested
tested: boolean
Generated using TypeDoc
Interface APIOption<T>
interface APIOption<T> {
_allParams: Map<string, ISchemaType>;
beforeHooks: Set<T>;
bodySchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
examples: IExample[];
group: string;
headersSchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
middlewares: Set<T>;
mock?: Record<string, unknown>;
paramsSchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
querySchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
realPath: string;
required: Set<string>;
requiredOneOf: string[][];
response?: TYPE_RESPONSE;
responseSchema?: ISchemaType | SchemaType;
tested: boolean;
[key: string]: unknown;
}
_allParams: Map<string, ISchemaType>;
beforeHooks: Set<T>;
bodySchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
examples: IExample[];
group: string;
headersSchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
middlewares: Set<T>;
mock?: Record<string, unknown>;
paramsSchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
querySchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>;
realPath: string;
required: Set<string>;
requiredOneOf: string[][];
response?: TYPE_RESPONSE;
responseSchema?: ISchemaType | SchemaType;
tested: boolean;
[key: string]: unknown;
}
Type Parameters
- T
Hierarchy
- Record<string, unknown>
- APIOption
Indexable
- [key: string]: unknown
Index
Properties
Properties
_
before
Optionalbody
bodySchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
examples
group
group: string
Optionalheaders
headersSchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
middlewares
Optionalmock
mock?: Record<string, unknown>
Optionalparams
paramsSchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
Optionalquery
querySchema?: ZodObject<
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
Readonly<
{
[k: string]: $ZodType<
unknown,
unknown,
$ZodTypeInternals<unknown, unknown>,
>;
},
>,
$strip,
>
real
realPath: string
required
required: Set<string>
required
requiredOneOf: string[][]
Optionalresponse
Optionalresponse
tested
tested: boolean
Interface IApiInfo<T>
API接口定义
-interface IApiInfo<T> {
$apis: Map<string, default<T>>;
afterHooks: Set<T>;
beforeHooks: Set<T>;
define: ((opt) => default<T>);
delete: ((path) => default<T>);
docOutputForamt?: ((out) => any);
docs?: default;
formatOutputReverse?: ((out) => [null | Error, any]);
get: ((path) => default<T>);
patch: ((path) => default<T>);
post: ((path) => default<T>);
put: ((path) => default<T>);
}
$apis: Map<string, default<T>>;
afterHooks: Set<T>;
beforeHooks: Set<T>;
define: ((opt) => default<T>);
delete: ((path) => default<T>);
docOutputForamt?: ((out) => any);
docs?: default;
formatOutputReverse?: ((out) => [null | Error, any]);
get: ((path) => default<T>);
patch: ((path) => default<T>);
post: ((path) => default<T>);
put: ((path) => default<T>);
}
Type Parameters
Hierarchy (view full)
Index
Properties
$apis
-after
Properties
Readonly $apis
after
before
define
Readonly delete
Optional doc
doc
Type declaration
- (out): any
Parameters
out: any
Returns any
Optional docs
docs?: default
Optional format
format
Type declaration
- (out): [null | Error, any]
Parameters
out: any
Returns [null | Error, any]
Readonly get
Readonly patch
Readonly post
Readonly put
Generated using TypeDoc
Interface IApiInfo<T>
API接口定义
+interface IApiInfo<T> {
$apis: Map<string, API<T>>;
afterHooks: Set<T>;
beforeHooks: Set<T>;
define: (opt: APIDefine<T>) => API<T>;
delete: (path: string) => API<T>;
docOutputForamt?: (out: unknown) => unknown;
docs?: IAPIDoc;
formatOutputReverse?: (out: unknown) => [null | Error, unknown];
get: (path: string) => API<T>;
patch: (path: string) => API<T>;
post: (path: string) => API<T>;
put: (path: string) => API<T>;
[key: string]: unknown;
}
$apis: Map<string, API<T>>;
afterHooks: Set<T>;
beforeHooks: Set<T>;
define: (opt: APIDefine<T>) => API<T>;
delete: (path: string) => API<T>;
docOutputForamt?: (out: unknown) => unknown;
docs?: IAPIDoc;
formatOutputReverse?: (out: unknown) => [null | Error, unknown];
get: (path: string) => API<T>;
patch: (path: string) => API<T>;
post: (path: string) => API<T>;
put: (path: string) => API<T>;
[key: string]: unknown;
}
Type Parameters
- T
Hierarchy (View Summary)
Indexable
- [key: string]: unknown
Index
Properties
$apis
+after
Interface IApiOption
API定义
-interface IApiOption {
docs?: IDocOptions;
forceGroup?: boolean;
groups?: Record<string, string | IGroupInfoOpt>;
info?: IApiOptionInfo;
internalError?: ((msg) => Error);
invalidParameterError?: ((msg) => Error);
missingParameterError?: ((msg) => Error);
path?: string;
}
docs?: IDocOptions;
forceGroup?: boolean;
groups?: Record<string, string | IGroupInfoOpt>;
info?: IApiOptionInfo;
internalError?: ((msg) => Error);
invalidParameterError?: ((msg) => Error);
missingParameterError?: ((msg) => Error);
path?: string;
}
Index
Properties
Properties
Optional docs
Optional force
force
Optional groups
Optional info
Optional internal
internal
Type declaration
- (msg): Error
Parameters
msg: string
Returns Error
Optional invalid
invalid
Type declaration
- (msg): Error
Parameters
msg: string
Returns Error
Optional missing
missing
Type declaration
- (msg): Error
Parameters
msg: string
Returns Error
Optional path
path?: string
Generated using TypeDoc
Interface IApiOption
API定义
+interface IApiOption {
docs?: IDocOptions;
forceGroup?: boolean;
groups?: Record<string, string | IGroupInfoOpt>;
info?: IApiOptionInfo;
internalError?: (msg: string) => Error;
invalidParameterError?: (msg: string) => Error;
missingParameterError?: (msg: string) => Error;
path?: string;
}
docs?: IDocOptions;
forceGroup?: boolean;
groups?: Record<string, string | IGroupInfoOpt>;
info?: IApiOptionInfo;
internalError?: (msg: string) => Error;
invalidParameterError?: (msg: string) => Error;
missingParameterError?: (msg: string) => Error;
path?: string;
}
Index
Properties
Properties
Optionaldocs
Optionalforce
forceGroup?: boolean
Optionalgroups
Optionalinfo
Optionalinternal
internalError?: (msg: string) => Error
Optionalinvalid
invalidParameterError?: (msg: string) => Error
Optionalmissing
missingParameterError?: (msg: string) => Error
Optionalpath
path?: string
Interface IApiOptionInfo
API基础信息
-interface IApiOptionInfo {
basePath?: string;
description?: string;
host?: string;
title?: string;
version?: Date;
}
basePath?: string;
description?: string;
host?: string;
title?: string;
version?: Date;
}
Index
Properties
Properties
Optional base
base
API默认位置
-Optional description
description?: string
项目描述（可以为 markdown 字符串）
-Optional host
host?: string
服务器host地址
-Optional title
title?: string
项目标题
-Optional version
version?: Date
项目版本
-Generated using TypeDoc
Interface IApiOptionInfo
API基础信息
+interface IApiOptionInfo {
basePath?: string;
description?: string;
host?: string;
title?: string;
version?: Date;
}
basePath?: string;
description?: string;
host?: string;
title?: string;
version?: Date;
}
Index
Properties
Interface IDocOptions
文档生成信息
-interface IDocOptions {
all?: string | boolean;
axios?: string | boolean;
home?: string | boolean;
index?: string | boolean;
json?: string | boolean;
markdown?: string | boolean;
postman?: string | boolean;
swagger?: string | boolean;
wiki?: string | boolean;
}
all?: string | boolean;
axios?: string | boolean;
home?: string | boolean;
index?: string | boolean;
json?: string | boolean;
markdown?: string | boolean;
postman?: string | boolean;
swagger?: string | boolean;
wiki?: string | boolean;
}
Hierarchy
- Record<string, any>
- IDocOptions
Properties
Optional all
all?: string | boolean
生成 all-in-one.md
-Optional axios
axios?: string | boolean
生成 jssdk.js 基于（axios）
-Optional home
home?: string | boolean
生成 Home.md
-Optional index
index?: string | boolean
生成 Index.md
-Optional json
json?: string | boolean
生成 docs.json
-Optional markdown
markdown?: string | boolean
生成Markdown
-Optional postman
postman?: string | boolean
生成 postman.json
-Optional swagger
swagger?: string | boolean
生成 swagger.json
-Optional wiki
wiki?: string | boolean
生成wiki
-Generated using TypeDoc
Interface IDocOptions
文档生成信息
+interface IDocOptions {
all?: string | boolean;
axios?: string | boolean;
home?: string | boolean;
index?: string | boolean;
json?: string | boolean;
markdown?: string | boolean;
postman?: string | boolean;
swagger?: string | boolean;
wiki?: string | boolean;
[key: string]: unknown;
}
all?: string | boolean;
axios?: string | boolean;
home?: string | boolean;
index?: string | boolean;
json?: string | boolean;
markdown?: string | boolean;
postman?: string | boolean;
swagger?: string | boolean;
wiki?: string | boolean;
[key: string]: unknown;
}
Hierarchy
- Record<string, unknown>
- IDocOptions
Indexable
- [key: string]: unknown
Properties
Optionalall
all?: string | boolean
+
Optionalaxios
axios?: string | boolean
生成 jssdk.js 基于（axios）
+Optionalhome
home?: string | boolean
生成 Home.md
+Optionalindex
index?: string | boolean
生成 Index.md
+Optionaljson
json?: string | boolean
生成 docs.json
+Optionalmarkdown
markdown?: string | boolean
生成Markdown
+Optionalpostman
postman?: string | boolean
生成 postman.json
+Optionalswagger
swagger?: string | boolean
生成 swagger.json
+Optionalwiki
wiki?: string | boolean
生成wiki
+Interface IEnumParams
Hierarchy
- Array<string | number>
- IEnumParams
Indexable
- [n: number]: string | number
Interface IExample
interface IExample {
headers?: Record<string, any>;
input?: Record<string, any>;
name?: string;
output?: Record<string, any>;
path?: string;
}
headers?: Record<string, any>;
input?: Record<string, any>;
name?: string;
output?: Record<string, any>;
path?: string;
}
Properties
Optional headers
headers?: Record<string, any>
Optional input
input?: Record<string, any>
Optional name
name?: string
Optional output
output?: Record<string, any>
Optional path
path?: string
Generated using TypeDoc
diff --git a/docs/interfaces/IGroupInfoOpt.html b/docs/interfaces/IGroupInfoOpt.html
index 9286d4d..f9f97cd 100644
--- a/docs/interfaces/IGroupInfoOpt.html
+++ b/docs/interfaces/IGroupInfoOpt.html
@@ -1,3 +1,3 @@
-
Generated using TypeDoc
diff --git a/docs/interfaces/IGruop.html b/docs/interfaces/IGruop.html
index bbaabc1..7b1a921 100644
--- a/docs/interfaces/IGruop.html
+++ b/docs/interfaces/IGruop.html
@@ -1,10 +1,10 @@
-
Interface IGruop<T>
组方法
-interface IGruop<T> {
before: ((...fn) => IGruop<T>);
define: ((opt) => default<T>);
delete: ((path) => default<T>);
get: ((path) => default<T>);
middleware: ((...fn) => IGruop<T>);
patch: ((path) => default<T>);
post: ((path) => default<T>);
put: ((path) => default<T>);
}
before: ((...fn) => IGruop<T>);
define: ((opt) => default<T>);
delete: ((path) => default<T>);
get: ((path) => default<T>);
middleware: ((...fn) => IGruop<T>);
patch: ((path) => default<T>);
post: ((path) => default<T>);
put: ((path) => default<T>);
}
Type Parameters
Hierarchy (view full)
Properties
before
define
Readonly delete
Readonly get
middleware
Readonly patch
Readonly post
Readonly put
Generated using TypeDoc
Interface IGruop<T>
组方法
+interface IGruop<T> {
before: (...fn: T[]) => IGruop<T>;
define: (opt: APIDefine<T>) => API<T>;
delete: (path: string) => API<T>;
get: (path: string) => API<T>;
middleware: (...fn: T[]) => IGruop<T>;
patch: (path: string) => API<T>;
post: (path: string) => API<T>;
put: (path: string) => API<T>;
[key: string]: unknown;
}
before: (...fn: T[]) => IGruop<T>;
define: (opt: APIDefine<T>) => API<T>;
delete: (path: string) => API<T>;
get: (path: string) => API<T>;
middleware: (...fn: T[]) => IGruop<T>;
patch: (path: string) => API<T>;
post: (path: string) => API<T>;
put: (path: string) => API<T>;
[key: string]: unknown;
}
Type Parameters
- T
Hierarchy (View Summary)
Indexable
- [key: string]: unknown
diff --git a/docs/interfaces/ISchemaCheckResult.html b/docs/interfaces/ISchemaCheckResult.html
deleted file mode 100644
index bcbff6d..0000000
--- a/docs/interfaces/ISchemaCheckResult.html
+++ /dev/null
@@ -1,13 +0,0 @@
-
Interface ISchemaCheckResult
interface ISchemaCheckResult {
invalidParamaterTypes?: string[];
invalidParamaters?: string[];
message: string;
missingParamaters?: string[];
ok: boolean;
value: any;
}
invalidParamaterTypes?: string[];
invalidParamaters?: string[];
message: string;
missingParamaters?: string[];
ok: boolean;
value: any;
}
Index
Properties
Properties
Optional invalid
invalid
错误的参数类型列表
-Optional invalid
invalid
错误的参数列表
-message
message: string
如果失败，此项为出错信息
-Optional missing
missing
缺少的参数列表
-ok
ok: boolean
是否成功
-value
value: any
结果
-Generated using TypeDoc
diff --git a/docs/interfaces/ISchemaTypeFieldInfo.html b/docs/interfaces/ISchemaTypeFieldInfo.html
deleted file mode 100644
index c901dee..0000000
--- a/docs/interfaces/ISchemaTypeFieldInfo.html
+++ /dev/null
@@ -1,13 +0,0 @@
-
Interface ISchemaTypeFieldInfo
interface ISchemaTypeFieldInfo {
comment?: string;
default?: any;
format?: boolean;
params?: any;
required?: boolean;
type: string | SchemaType;
}
comment?: string;
default?: any;
format?: boolean;
params?: any;
required?: boolean;
type: string | SchemaType;
}
Properties
Optional comment
comment?: string
备注
-Optional default
default?: any
默认值
-Optional format
format?: boolean
是否格式化
-Optional params
params?: any
类型参数
-Optional required
required?: boolean
是否必须
-type
数据类型
-Generated using TypeDoc
Interface ISchemaTypeFields
Indexable
Generated using TypeDoc
Interface IValueResult
Hierarchy (view full)
- IValueTypeCheckResult
- IValueResult
Properties
Optional code
code?: string
错误代码
-message
message: string
如果失败，则表示出错信息
-ok
ok: boolean
是否成功
-value
value: any
值
-Generated using TypeDoc
Generated using TypeDoc
Interface IValueTypeOptions
interface IValueTypeOptions {
checker?: RegExp | ((v, p?) => boolean);
description?: string;
formatter?: ((v) => any);
isBuiltin?: boolean;
isDefaultFormat?: boolean;
isParamsRequired?: boolean;
nullable?: boolean;
paramsChecker?: ((p) => boolean);
parser?: ((v) => any);
swaggerType?: SWAGGER_TYPE;
tsType?: string;
}
checker?: RegExp | ((v, p?) => boolean);
description?: string;
formatter?: ((v) => any);
isBuiltin?: boolean;
isDefaultFormat?: boolean;
isParamsRequired?: boolean;
nullable?: boolean;
paramsChecker?: ((p) => boolean);
parser?: ((v) => any);
swaggerType?: SWAGGER_TYPE;
tsType?: string;
}
Index
Properties
Properties
Optional checker
checker?: RegExp | ((v, p?) => boolean)
② 检查方法
-Type declaration
- (v, p?): boolean
Parameters
v: any
Optionalp: any
Returns boolean
Optional description
description?: string
说明信息
-Optional formatter
formatter?: ((v) => any)
③ 格式化方法
-Type declaration
- (v): any
③ 格式化方法
-Parameters
v: any
Returns any
Optional is
is
是否为系统内置的类型
-Optional is
is
是否默认自动格式化
-Optional is
is
类型动态参数是否必须
-Optional nullable
nullable?: boolean
能否为 null
-Optional params
params
类型动态参数检查器
-Type declaration
- (p): boolean
类型动态参数检查器
-Parameters
p: any
Returns boolean
Optional parser
parser?: ((v) => any)
① 解析方法
-Type declaration
- (v): any
① 解析方法
-Parameters
v: any
Returns any
Optional swagger
对应的swagger 文档的类型
-Optional ts
ts
对应的TypeScript类型
-Generated using TypeDoc
Interface SchemaManagerOptions
Index
Properties
abort
Properties
Optional abort
abort
如果为true则解析时遇到第一个错误即停止接续解析
-Optional type
Generated using TypeDoc
Generated using TypeDoc
erest
Index
Classes
Interfaces
Type Aliases
Variables
Functions
Generated using TypeDoc
erest
Classes
Interfaces
Variables
Type alias DEFAULT_HANDLER
DEFAULT_
Type declaration
- (...args): any
Parameters
Rest...args: any[]
Returns any
Generated using TypeDoc
Type Alias DEFAULT_HANDLER
DEFAULT_HANDLER: (...args: unknown[]) => unknown
Type declaration
- (...args: unknown[]): unknown
Parameters
- ...args: unknown[]
Returns unknown
Type Alias IArrayParams
Type alias SUPPORT_METHODS
Generated using TypeDoc
Type Alias SUPPORT_METHODS
Type alias SWAGGER_TYPE
SWAGGER_
@tuzhanai/value-type-manager
-Generated using TypeDoc
diff --git a/docs/types/TYPE_RESPONSE.html b/docs/types/TYPE_RESPONSE.html
index d44470d..e2bb7c6 100644
--- a/docs/types/TYPE_RESPONSE.html
+++ b/docs/types/TYPE_RESPONSE.html
@@ -1 +1 @@
-
Type alias TYPE_RESPONSE
Generated using TypeDoc
Type Alias TYPE_RESPONSE
Generated using TypeDoc
Type Alias genSchema<T>
Schema方法
+Type Parameters
- T
Variable CODE_CHECK_FAILUREConst
CODE_
类型检查出错
-Generated using TypeDoc
Variable CODE_FORMAT_FAILUREConst
CODE_
类型格式化出错
-Generated using TypeDoc
Variable CODE_PARSE_FAILUREConst
CODE_
类型解析出错
-Generated using TypeDoc
Variable CODE_UNKNOWN_FAILUREConst
CODE_
未知错误
-Generated using TypeDoc
Variable SUPPORT_METHODConst
SUPPORT_
Generated using TypeDoc
Variable SUPPORT_METHODConst
SUPPORT_METHOD: readonly ["get", "post", "put", "delete", "patch"] = ...
Variable zodTypeMapConst
zodTypeMap: {
Alpha: ZodString;
AlphaNumeric: ZodString;
any: ZodAny;
Any: ZodAny;
array: ZodArray<ZodAny>;
Array: ZodArray<ZodAny>;
Ascii: ZodString;
Base64: ZodString;
boolean: ZodUnion<
readonly [
ZodBoolean,
ZodPipe<ZodString, ZodTransform<boolean, string>>,
],
>;
Boolean: ZodUnion<
readonly [
ZodBoolean,
ZodPipe<ZodString, ZodTransform<boolean, string>>,
],
>;
date: ZodUnion<
readonly [ZodDate, ZodPipe<ZodString, ZodTransform<Date, string>>],
>;
Date: ZodUnion<
readonly [ZodDate, ZodPipe<ZodString, ZodTransform<Date, string>>],
>;
Domain: ZodString;
email: ZodString;
Email: ZodString;
ENUM: ZodEnum<{ placeholder: "placeholder" }>;
Float: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
IntArray: ZodUnion<
readonly [
ZodArray<ZodNumber>,
ZodPipe<ZodString, ZodTransform<number[], string>>,
],
>;
Integer: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
JSON: ZodAny;
JSONString: ZodString;
MongoIdString: ZodString;
NullableInteger: ZodNullable<
ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>,
>;
NullableString: ZodNullable<ZodString>;
number: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
Number: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
object: ZodObject<{}, $strip>;
Object: ZodAny;
string: ZodString;
String: ZodString;
StringArray: ZodUnion<
readonly [
ZodArray<ZodString>,
ZodPipe<ZodString, ZodTransform<string[], string>>,
ZodPipe<ZodArray<ZodAny>, ZodTransform<string[], any[]>>,
],
>;
TrimString: ZodPipe<ZodString, ZodTransform<string, string>>;
url: ZodString;
URL: ZodString;
uuid: ZodString;
} = ...
Alpha: ZodString;
AlphaNumeric: ZodString;
any: ZodAny;
Any: ZodAny;
array: ZodArray<ZodAny>;
Array: ZodArray<ZodAny>;
Ascii: ZodString;
Base64: ZodString;
boolean: ZodUnion<
readonly [
ZodBoolean,
ZodPipe<ZodString, ZodTransform<boolean, string>>,
],
>;
Boolean: ZodUnion<
readonly [
ZodBoolean,
ZodPipe<ZodString, ZodTransform<boolean, string>>,
],
>;
date: ZodUnion<
readonly [ZodDate, ZodPipe<ZodString, ZodTransform<Date, string>>],
>;
Date: ZodUnion<
readonly [ZodDate, ZodPipe<ZodString, ZodTransform<Date, string>>],
>;
Domain: ZodString;
email: ZodString;
Email: ZodString;
ENUM: ZodEnum<{ placeholder: "placeholder" }>;
Float: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
IntArray: ZodUnion<
readonly [
ZodArray<ZodNumber>,
ZodPipe<ZodString, ZodTransform<number[], string>>,
],
>;
Integer: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
JSON: ZodAny;
JSONString: ZodString;
MongoIdString: ZodString;
NullableInteger: ZodNullable<
ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>,
>;
NullableString: ZodNullable<ZodString>;
number: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
Number: ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>;
object: ZodObject<{}, $strip>;
Object: ZodAny;
string: ZodString;
String: ZodString;
StringArray: ZodUnion<
readonly [
ZodArray<ZodString>,
ZodPipe<ZodString, ZodTransform<string[], string>>,
ZodPipe<ZodArray<ZodAny>, ZodTransform<string[], any[]>>,
],
>;
TrimString: ZodPipe<ZodString, ZodTransform<string, string>>;
url: ZodString;
URL: ZodString;
uuid: ZodString;
} = ...
Type declaration
ReadonlyAlpha: ZodStringReadonlyAlphaNumeric: ZodStringReadonlyany: ZodAnyReadonlyAny: ZodAnyReadonlyarray: ZodArray<ZodAny>ReadonlyArray: ZodArray<ZodAny>ReadonlyAscii: ZodStringReadonlyBase64: ZodStringReadonlyboolean: ZodUnion<
readonly [ZodBoolean, ZodPipe<ZodString, ZodTransform<boolean, string>>],
>ReadonlyBoolean: ZodUnion<
readonly [ZodBoolean, ZodPipe<ZodString, ZodTransform<boolean, string>>],
>Readonlydate: ZodUnion<readonly [ZodDate, ZodPipe<ZodString, ZodTransform<Date, string>>]>ReadonlyDate: ZodUnion<readonly [ZodDate, ZodPipe<ZodString, ZodTransform<Date, string>>]>ReadonlyDomain: ZodStringReadonlyemail: ZodStringReadonlyEmail: ZodStringReadonlyENUM: ZodEnum<{ placeholder: "placeholder" }>ReadonlyFloat: ZodUnion<readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>]>ReadonlyIntArray: ZodUnion<
readonly [
ZodArray<ZodNumber>,
ZodPipe<ZodString, ZodTransform<number[], string>>,
],
>ReadonlyInteger: ZodUnion<readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>]>ReadonlyJSON: ZodAnyReadonlyJSONString: ZodStringReadonlyMongoIdString: ZodStringReadonlyNullableInteger: ZodNullable<
ZodUnion<
readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>],
>,
>ReadonlyNullableString: ZodNullable<ZodString>Readonlynumber: ZodUnion<readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>]>ReadonlyNumber: ZodUnion<readonly [ZodNumber, ZodPipe<ZodString, ZodTransform<number, string>>]>Readonlyobject: ZodObject<{}, $strip>ReadonlyObject: ZodAnyReadonlystring: ZodStringReadonlyString: ZodStringReadonlyStringArray: ZodUnion<
readonly [
ZodArray<ZodString>,
ZodPipe<ZodString, ZodTransform<string[], string>>,
ZodPipe<ZodArray<ZodAny>, ZodTransform<string[], any[]>>,
],
>ReadonlyTrimString: ZodPipe<ZodString, ZodTransform<string, string>>Readonlyurl: ZodStringReadonlyURL: ZodStringReadonlyuuid: ZodString
获取 abortEarly 选项
-