Skip to content

API 快速开始 ​

了解如何在 Kooboo 中使用 KScript API

什么是 KScript ​

KScript 是 Kooboo 的脚本语言,基于 JavaScript/TypeScript 语法。你可以在 Kooboo 站点的代码块、API、模块中编写 KScript。

基本结构 ​

ts
// 创建一个 GET API
k.api.get(() => {
    return { message: "Hello Kooboo" }
})

// 创建一个 POST API(表单或 JSON 请求体)
k.api.post(() => {
    const form = k.request.form
    const body = k.request.body // JSON 字符串时需自行 parse
    return { received: form, body }
})

全局对象 k ​

k 对象是 KScript 的全局入口,提供所有内置功能:

模块描述
k.requestHTTP 请求数据
k.responseHTTP 响应操作
k.session会话状态管理
k.DB数据库操作
k.content内容管理
k.file文件操作
k.site站点管理(页面、布局、菜单等)
k.net网络请求
k.commerce电商功能
k.payment支付功能
k.mail邮件发送

类型提示 ​

在 kb-doc 项目或 IDE 中,你可以引入 kooboo.d.ts 获取完整的 TypeScript 类型提示:

ts
/// <reference path="kooboo.d.ts" />

// 现在你将获得完整的代码补全和类型检查
k.DB.

下一步 ​