docs: 补全 src 全部 Kotlin KDoc 与 Java Javadoc,版本升级至 5.5.1
Gitea Actions Build / Build (push) Canceled after 0s
Gitea Actions Build / Build (push) Canceled after 0s
为所有缺失文档的公开声明补充中文 KDoc/Javadoc(含 exception、json、 springboot、tuple 生成类、MediaType 枚举项及测试),仅插入注释不改代码; gradle.properties VERSIONS 5.4.4 -> 5.5.1。
This commit is contained in:
@@ -22,10 +22,22 @@
|
||||
|
||||
package com.mingliqiye.utils.http
|
||||
|
||||
/**
|
||||
* HTTP 响应基类,封装时间、消息、数据和状态码等通用响应字段。
|
||||
*
|
||||
* 除 [time] 外字段均可变,本身非线程安全;
|
||||
* 如需不可变更新语义,请使用子类的 with* 系列方法。
|
||||
*
|
||||
* @param T 响应数据的类型
|
||||
*/
|
||||
open class BaseResponse<T>(
|
||||
/** 响应时间(格式化的字符串),创建后不可修改 */
|
||||
open val time: String,
|
||||
/** 响应消息,可通过 setter 修改 */
|
||||
open var message: String,
|
||||
/** 响应数据,可通过 setter 修改 */
|
||||
open var data: T,
|
||||
/** HTTP 状态码,可通过 setter 修改 */
|
||||
open var statusCode: Int,
|
||||
|
||||
) {
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -26,4 +26,9 @@ package com.mingliqiye.utils.http
|
||||
import okhttp3.MediaType.Companion.toMediaType
|
||||
|
||||
|
||||
/**
|
||||
* 将本枚举转换为 OkHttp 的 [okhttp3.MediaType]。
|
||||
*
|
||||
* @return 与 [MediaType.value] 对应的 OkHttp 媒体类型
|
||||
*/
|
||||
fun MediaType.okhttp(): okhttp3.MediaType = this.value.toMediaType()
|
||||
|
||||
@@ -53,7 +53,15 @@ data class PageData<T>(
|
||||
*/
|
||||
val pageIndex: Long = 0,
|
||||
) {
|
||||
/** 伴生对象,提供工厂方法 */
|
||||
companion object {
|
||||
/**
|
||||
* 从 MyBatis-Plus 的分页对象构建分页数据
|
||||
*
|
||||
* @param T 记录类型
|
||||
* @param page MyBatis-Plus 分页对象
|
||||
* @return 转换后的分页数据
|
||||
*/
|
||||
fun <T> of(page: Page<T>): PageData<T> = PageData(
|
||||
records = page.records,
|
||||
totalCount = page.total,
|
||||
|
||||
@@ -25,6 +25,18 @@ package com.mingliqiye.utils.http
|
||||
import com.baomidou.mybatisplus.extension.plugins.pagination.Page
|
||||
import com.mingliqiye.utils.time.DateTime
|
||||
|
||||
/**
|
||||
* 分页 HTTP 响应数据类,数据部分为 [PageData] 分页结构。
|
||||
*
|
||||
* 继承 [BaseResponse],支持链式调用与 with* 不可变更新,
|
||||
* 并提供多种工厂方法创建成功/错误响应。
|
||||
*
|
||||
* @param T 分页记录的类型
|
||||
* @property time 响应时间(格式化的字符串)
|
||||
* @property message 响应消息
|
||||
* @property data 分页响应数据
|
||||
* @property statusCode HTTP 状态码
|
||||
*/
|
||||
data class PagedResponse<T>(
|
||||
override val time: String, // 响应时间,一旦创建不可修改
|
||||
override var message: String, // 响应消息,可通过setter修改
|
||||
@@ -36,6 +48,7 @@ data class PagedResponse<T>(
|
||||
data,
|
||||
statusCode
|
||||
) {
|
||||
/** 伴生对象,提供各类分页响应的工厂方法 */
|
||||
companion object {
|
||||
/**
|
||||
* 创建一个默认的成功响应对象
|
||||
|
||||
@@ -49,6 +49,7 @@ data class Response<T>(
|
||||
statusCode,
|
||||
) {
|
||||
|
||||
/** 伴生对象,提供各类响应的工厂方法 */
|
||||
companion object {
|
||||
/**
|
||||
* 创建一个默认的成功响应对象
|
||||
|
||||
@@ -300,6 +300,23 @@ enum class Method {
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* 在 [Request.Builder] 上设置 POST 方法,使用空请求体。
|
||||
*
|
||||
* @return 当前 [Request.Builder],便于链式调用
|
||||
*/
|
||||
fun Request.Builder.post() = post(RequestBody.EMPTY)
|
||||
|
||||
/**
|
||||
* 在 [Request.Builder] 上设置 PUT 方法,使用空请求体。
|
||||
*
|
||||
* @return 当前 [Request.Builder],便于链式调用
|
||||
*/
|
||||
fun Request.Builder.put() = put(RequestBody.EMPTY)
|
||||
|
||||
/**
|
||||
* 在 [Request.Builder] 上设置 PATCH 方法,使用空请求体。
|
||||
*
|
||||
* @return 当前 [Request.Builder],便于链式调用
|
||||
*/
|
||||
fun Request.Builder.patch() = patch(RequestBody.EMPTY)
|
||||
|
||||
Reference in New Issue
Block a user