zentao-api / ModuleAction

Interface: ModuleAction

禅道模块中的单个 API 动作定义。

Properties

Property	Type	Description
description?	string	动作说明。
display?	string	面向用户展示的动作名称。
method?	ModuleActionMethod	HTTP 方法；省略时按 type 自动推导： list/get → GET、create/action → POST、update → PUT、delete → DELETE。 当 type 无法推导出方法时抛出 E_INDETERMINATE_ACTION_METHOD。
name	ModuleActionName	动作名称，例如 list、get、close。
pagerGetter?	string | ModuleActionPagerGetterMap | ModuleActionGetterFn<Pager>	从原始响应中提取分页信息的位置或函数： 字符串为字段路径（支持 a.b 嵌套）、对象为字段映射、函数则接收原始响应与调用参数。
params?	readonly ModuleActionParam[]	查询参数定义。
path	string	API 路径模板，可包含 {productID} 等路径参数。
pathParams?	Readonly<Record<string, string | Omit<ModuleActionParam, "name">>>	路径参数定义；字符串为说明，对象可携带默认值和可选项。
requestBody?	ModuleActionRequestBody	请求体定义。
resultGetter?	string | Readonly<Record<string, string>> | ModuleActionGetterFn<unknown>	从原始响应中提取业务数据的位置或函数： 字符串为字段路径（支持 a.b 嵌套）、对象为字段映射、函数则接收原始响应与调用参数。
resultType?	ModuleActionResultType	结果形态；省略时按 type 自动推导： list → list、get/create/update → object、delete/action → text。 当 type 无法推导出结果形态时抛出 E_INDETERMINATE_ACTION_RESULT_TYPE。
type	ModuleActionType	动作类型，决定高阶 request 的路径/参数解析策略，并在 method、resultType 省略时作为推导依据。