后端 API
适用对象:正在查后端运行时对象、脚本上下文、表达式能力和 Java 接口的开发者。
这部分文档关注的是“运行时能直接拿到什么、接口怎么用、扩展点从哪里接”,不是业务概念介绍,也不是 HTTP 接口规范。
从哪里开始查
- 想查脚本里能直接拿到哪些对象:看 脚本上下文
- 想查表达式
${...}能直接用哪些变量和工具:看 表达式上下文 - 想查模型查询、字段读取和结构化访问:看 数据模型 API
- 想查 Java 实体接口和工具类:看 Java API
- 想查复杂查询表达:看 查询 DSL
按问题类型快速定位
| 你现在的问题 | 建议先看哪里 |
|---|---|
我在写 ${...},不知道能直接用什么 | 表达式上下文 |
| 我在写脚本,需要用户、组织、模型、日志、配置对象 | 脚本上下文 |
| 我想按名称或类型拿数据模型,再做查询或写入 | 数据模型 API |
| 我想确认 Java 工具类或实体对象有哪些稳定方法 | Java API |
| 我在查筛选、分页、排序、关联等 DSL 结构 | 查询 DSL |
| 我其实不是在查 API,而是在决定怎么扩展平台 | 扩展后端 |
相关概念
使用提醒
- 表达式上下文和脚本上下文都属于“运行时可直接使用的对象”,但脚本上下文通常更完整
- 如果你当前在做的是扩展入口选择,而不是查具体接口,请先回到 融合开发
- 如果你当前要看的是接口风格和返回约定,而不是运行时对象,请转到 Web API 规范
一条推荐阅读路径
如果你是第一次接触潮汐栈的后端运行时,通常按下面顺序最顺:
- 先看 脚本上下文 和 表达式上下文,建立“平台已经给了我什么”的基本认知。
- 再看 数据模型 API,理解运行时如何读写模型数据。
- 需要确认具体 Java 类型或工具类时,再进入 Java API。
- 要处理更复杂的查询语句时,最后下钻到 查询 DSL。
这部分不解决什么
- 不讲业务模型、菜单、页面等概念建模过程。
- 不讲应用部署、升级和运维问题。
- 不讲前端 SDK 或组件能力。
如果你当前卡的是这些问题,更适合回到:
目录
📄️ 数据查询 DSL
查询 DSL 是一种用于构建查询语句的结构化的表达方式,DSL 基于 Map/List 结构,在保持简便性的同时,也提供了一种可以更好地控制和描述查询的方式。
🗃️ 数据模型 API
8 个项目
📄️ 脚本上下文
这页收录的是脚本运行时可直接使用的对象与工具。当前平台脚本主要支持 JavaScript(GraalVM)和 Groovy,两者共享同一套上下文注入机制。
📄️ 表达式上下文
这页收录的是 ${...} 表达式运行时可直接使用的上下文对象和工具。
🗃️ Java API
2 个项目