REST API

Jmix 提供通用的 REST API,可以无需编写后端 REST 控制器即可处理数据模型实体和业务服务。能自动开放下列功能接口:

  • 实体增删查改操作。

  • 调用注册的服务方法。

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

  • 上传和下载文件。

  • 获取数据模型的信息。

  • 获取当前用户和用户权限的信息。

可以用 Swagger UI 网页开放通用 REST 接口,地址为: https://docs.jmix.io/openapi/1.4

REST API 使用 OAuth2 协议进行用户验证和匿名访问支持。所有的 REST API 接口都遵循数据访问限制机制,由 安全子系统 提供。

安装

通用 REST API 是一个可选的扩展组件。按照 扩展组件 章节的说明通过 Jmix 市场进行自动安装。

手动安装,在 build.gradle 添加下列依赖:

implementation 'io.jmix.rest:jmix-rest-starter'
implementation 'io.jmix.security:jmix-security-oauth2-starter'