Skip to content

写第一个 KScript API ​

在 Kooboo 中加入一个服务端接口,让前台页面可以读取 JSON 或执行业务逻辑。

先选入口 ​

入口适合场景文档
API 页面有独立 URL,需要返回 JSON 或处理表单CMS:Open API · k.api
CodeBlock多个页面或 API 复用同一段逻辑CMS:代码 · k.site.codes
定时任务定期同步、清理、发送通知CMS:定时任务 · k.site.runJob

第一次建议从 API 页面开始:输入 URL、保存脚本,然后在浏览器或前台 fetch 中调用。

一个最小 API 需要考虑什么 ​

项目说明
路由给 API 一个稳定 URL,例如 /api/news
输入从 k.request 读取 query、body、headers 或 files
业务数据用 k.content、k.DB 或外部接口取数
输出用 k.response 返回 JSON、重定向或状态码
权限需要登录时读取 k.session 或账户相关 API
日志关键失败路径写入 k.logger

与后台配置配合 ​

你要做先配哪里
读取内容列表数据类型 与 内容文件夹
发送邮件k.mail
发起支付Payment 集成 与 k.payment
调第三方接口Open API 或 k.net.httpClient
保存业务数据数据库 与 k.DB

调试建议 ​

  1. 先用固定返回值确认路由可以访问。
  2. 再接入真实数据查询。
  3. 给错误路径返回明确状态码与 JSON。
  4. 最后在页面中调用 API,并检查浏览器 Network。