3.9. REST API

全局的 REST API 提供以下功能:

  • 实体的增删查改(CRUD)操作。

  • 执行预定义的 JPQL 查询语句。

  • 执行服务(Service)方法。

  • 获取元数据(实体、视图、枚举、数据类型)。

  • 获取当前用户权限(访问实体、实体属性、特殊权限)。

  • 获取当前用户信息(名称、语言、时区等)。

  • 上传和下载文件。

REST API 使用 OAuth2 协议来做认证,并且支持匿名访问。

API 端点(endpoint)的详细文档:http://files.cuba-platform.com/swagger/7.0

使用 REST API cookbook 章节包含了很多实际使用 REST API 的例子。以下提供一些功能和配置选项的正式说明。