mcpField
K
kwc-ks-controller-development

kwc-ks-controller-development

github.com/kingdee开发237 次安装27 周前更新
代码仓库

关于 kwc-ks-controller-development

kwc-ks-controller-development 用于在已初始化的 KWC 项目中实现 KingScript 脚本控制器及其 .kws 元数据。它指导开发者检查配置、编写元数据和 API,并按要求查阅参考资料;项目初始化与部署则交由 kwc-project-scaffold。

主要功能

  1. 01配置 .kws 元数据
  2. 02使用 KingScript 实现 REST API 控制器
  3. 03读取项目配置后再拼接 URL
  4. 04通过 meta-query-api.mjs 查询实体字段
  5. 05查阅 SDK 索引和控制器指南
  6. 06将构建与部署交回 scaffold

适用场景

  1. 01为已初始化的 KWC 项目添加控制器
  2. 02定义控制器路由、HTTP 方法和权限
  3. 03依据查询到的字段结构实现实体操作

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/kingdee/kwc-skills --skill kwc-ks-controller-development

安装后在 Claude Code 中输入/kwc-ks-controller-development确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

rule.md
reference/
controller-patterns.md
controller-scaffold-workflow.md
faq.md
frontend-integration.md
kws-metadata-reference.md
脚本控制器防坑指南.md

详细介绍

来自项目 README

KWC KS Controller 开发专家

当项目中需要开发 KingScript 脚本控制器(后端 REST API)时,本 Skill 负责控制器的 .kws 元数据配置和脚本代码实现。

必须严格遵守本 Skill 目录下的 rule.md 中定义的硬性约束。

使用前置条件

必须同时满足以下条件才能使用本 Skill:

  1. 当前目录已存在 .kd/config.json 文件
  2. 工程中已存在 app/ks/controller/ 目录
  3. 工程已通过 kwc-project-scaffold 完成初始化

以下场景必须交由 kwc-project-scaffold:

  • 工程初始化、创建组件/页面/Controller 目录(kd project init / kd project create)
  • 生成或修改 .js-meta.kwc / .page-meta.kwp 元数据
  • 环境配置、构建、部署、调试(kd env / npm run build / kd project deploy / kd debug)

若当前不满足上述前置条件,请立即停止并切换到 kwc-project-scaffold Skill。

标准工作流

  1. 确认目录存在:Controller 目录已由 scaffold 创建(app/ks/controller/<Name>/)
  2. 读取工程配置(强制):读取 .kd/config.json,获取 isv、app 等字段的真实值,后续 .kws 中的 <isv>、<app>、<url> 必须基于这些值拼装,禁止猜测或硬编码
  3. 查询实体字段(涉及业务实体操作时):通过 meta-query-api.mjs 获取真实字段结构,禁止猜测字段名
  4. 编写 .kws 元数据:基于第 2 步读取的配置拼装 URL(/{isv}/{app}/...),定义 HTTP 方法和权限
  5. 编写脚本代码:开始写代码前,必须先读取 ./reference/脚本控制器防坑指南.md,确保不使用不存在的 API、不踩已知运行时陷阱;SDK 调用前先在索引中确认存在
  6. 交付构建:完成后通知用户回到 scaffold 进行部署

参考资源

类别资源路径
本 Skill.kws 元数据配置规范./reference/kws-metadata-reference.md
Controller 集成工作流./reference/controller-scaffold-workflow.md
常见模式和代码示例./reference/controller-patterns.md
前端 adapterApi 调用指南./reference/frontend-integration.md
KingScript脚本控制器开发指南../kingscript-code-generator/references/docs/custom-development/脚本控制器开发指南.md
脚本控制器防坑指南./reference/脚本控制器防坑指南.md
语言基础../kingscript-code-generator/references/language/kingscript/README.md
SDK 类索引../kingscript-code-generator/references/sdk/indexes/class-index.md
SDK 方法索引../kingscript-code-generator/references/sdk/indexes/method-index.md
SDK 场景索引../kingscript-code-generator/references/sdk/indexes/scenario-index.md
SDK 策略和降级链路../kingscript-code-generator/references/sdk/strategy.md
Java-KS 类型桥接../kingscript-code-generator/references/sdk/docs/java-kingscript-bridge.md
Scaffold实体字段查询工具../kwc-project-scaffold/references/meta-query.md

评论

支持 Markdown