Ktor Jimmer Rest¶

基于 Ktor 和 Jimmer 的快捷 Restful API 工具包。

厌烦了重复编写繁琐的 CRUD 代码？试试这个！快速开始

特性¶

一个 api<T> 搞定全部 CRUD：自动注册查询/创建/更新/删除 + count/exists，可选 PATCH 与批量端点
声明式过滤与排序：复用 Jimmer 查询 DSL，eq?/in?/lt?/gt?/ilike?/between? 等自动映射参数，sort() 动态排序
写操作可配置：create {}/edit {}/patch {} 独立配置保存模式与响应投影
灵活的投影：Fetcher DSL 或生成的 View DTO 二选一
输入与校验：实体或 Jimmer Input DTO，内置校验 DSL 与 transformer
批量操作：batch {} 启用批量创建/更新/删除
自定义动作：action {} 在 api<T> 内注册任意路由
统一错误响应：ApiError envelope + 一行 jimmerRestErrors()
可定制解析与分页：自定义类型解析器、默认分页参数、自定义分页对象
即插即用：所有配置都收敛在 JimmerRest Ktor 插件里

使用前

routing {
    route("/book") {
        get("/{id}") {
            val id = call.defaultPathVariable.parse(entityIdType<Book>())
            val book = sqlClient.findById(Book::class, id)
            call.respond(book)
        }
        get {
            val pageIndex = call.request.queryParameters["pageIndex"]?.toInt() ?: 0
            val pageSize = call.request.queryParameters["pageSize"]?.toInt() ?: 10
            // ...手工拼接查询条件、排序、分页、异常处理
        }
        post { /* 接收、校验、转换、保存 */ }
        put { /* 接收、校验、转换、更新 */ }
        delete("/{id}") { /* 解析 id、删除 */ }
    }
}

使用后

routing {
    api<Book>("/book") {
        filter {
            where(
                `ilike?`(table.name),
                `between?`(table.price)
            )
            where(Book::authors) {         // 关联过滤（EXISTS）
                `ilike?`(table.firstName)
            }
            orderBy(table.id.desc())
        }
        fetcher {
            fetch.by {
                allScalarFields()
                store { name(); website() }
            }
        }
        input {
            validator {
                with(it) {
                    ::name.notBlank { "名称不能为空" }
                }
            }
        }
    }
}

Ktor Jimmer Rest¶

特性¶

文档¶