ContiNew/continew-starter
1
1
Fork 0
mirror of https://github.com/continew-org/continew-starter.git synced 2025-10-31 22:57:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

style: 统一请求参数、响应参数注释

Browse Source
This commit is contained in:
Charles7c
2025-04-16 21:52:49 +08:00
parent 4e7cd51868
commit 934a5f7b6d
6 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/controller/AbstractBaseController.java
View File

@@ -45,7 +45,7 @@ import java.util.List;
* @param <L> 列表类型 * @param <L> 列表类型
* @param <D> 详情类型 * @param <D> 详情类型
* @param <Q> 查询条件 * @param <Q> 查询条件
* @param <C> 创建或修改参数类型 * @param <C> 创建或修改请求参数类型
* @author Charles7c * @author Charles7c
* @since 1.0.0 * @since 1.0.0
*/ */
@@ -117,7 +117,7 @@ public abstract class AbstractBaseController<S extends BaseService<L, D, Q, C>,
/** /**
* 创建 * 创建
* *
* @param req 创建参数 * @param req 创建请求参数
* @return ID * @return ID
*/ */
@CrudApi(Api.CREATE) @CrudApi(Api.CREATE)
@@ -131,7 +131,7 @@ public abstract class AbstractBaseController<S extends BaseService<L, D, Q, C>,
/** /**
* 修改 * 修改
* *
* @param req 修改参数 * @param req 修改请求参数
* @param id ID * @param id ID
*/ */
@CrudApi(Api.UPDATE) @CrudApi(Api.UPDATE)
@@ -146,7 +146,7 @@ public abstract class AbstractBaseController<S extends BaseService<L, D, Q, C>,
/** /**
* 删除 * 删除
* *
* @param req 删除参数 * @param req 删除请求参数
*/ */
@CrudApi(Api.DELETE) @CrudApi(Api.DELETE)
@Operation(summary = "删除数据", description = "删除数据") @Operation(summary = "删除数据", description = "删除数据")

4
continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/model/resp/BasePageResp.java
View File

@@ -23,13 +23,13 @@ import java.io.Serializable;
import java.util.List; import java.util.List;
/** /**
* 分页信息 * 分页响应参数
* *
* @param <T> 列表数据类型 * @param <T> 列表数据类型
* @author Charles7c * @author Charles7c
* @since 2.5.2 * @since 2.5.2
*/ */
@Schema(description = "分页信息") @Schema(description = "分页响应参数")
public class BasePageResp<T> implements Serializable { public class BasePageResp<T> implements Serializable {
@Serial @Serial

2
continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/model/resp/IdResp.java
View File

@@ -21,7 +21,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
import java.io.Serializable; import java.io.Serializable;
/** /**
* ID 响应信息 * ID 响应参数
* *
* @author Charles7c * @author Charles7c
* @since 2.5.0 * @since 2.5.0

4
continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/model/resp/LabelValueResp.java
View File

@@ -23,13 +23,13 @@ import java.io.Serial;
import java.io.Serializable; import java.io.Serializable;
/** /**
* 键值对信息 * 键值对响应参数
* *
* @param <T> * @param <T>
* @author Charles7c * @author Charles7c
* @since 2.1.0 * @since 2.1.0
*/ */
@Schema(description = "键值对信息") @Schema(description = "键值对响应参数")
public class LabelValueResp<T> implements Serializable { public class LabelValueResp<T> implements Serializable {
@Serial @Serial

6
continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-core/src/main/java/top/continew/starter/extension/crud/service/BaseService.java
View File

@@ -31,7 +31,7 @@ import java.util.List;
* @param <L> 列表类型 * @param <L> 列表类型
* @param <D> 详情类型 * @param <D> 详情类型
* @param <Q> 查询条件 * @param <Q> 查询条件
* @param <C> 创建或修改参数类型 * @param <C> 创建或修改请求参数类型
* @author Charles7c * @author Charles7c
* @since 1.0.0 * @since 1.0.0
*/ */
@@ -90,7 +90,7 @@ public interface BaseService<L, D, Q, C> {
/** /**
* 创建 * 创建
* *
* @param req 创建参数 * @param req 创建请求参数
* @return 自增 ID * @return 自增 ID
*/ */
Long create(C req); Long create(C req);
@@ -98,7 +98,7 @@ public interface BaseService<L, D, Q, C> {
/** /**
* 修改 * 修改
* *
* @param req 修改参数 * @param req 修改请求参数
* @param id ID * @param id ID
*/ */
void update(C req, Long id); void update(C req, Long id);

2
continew-starter-extension/continew-starter-extension-crud/continew-starter-extension-crud-mf/src/main/java/top/continew/starter/extension/crud/service/BaseServiceImpl.java
View File

@@ -59,7 +59,7 @@ import java.util.Optional;
* @param <L> 列表类型 * @param <L> 列表类型
* @param <D> 详情类型 * @param <D> 详情类型
* @param <Q> 查询条件 * @param <Q> 查询条件
* @param <C> 创建或修改参数类型 * @param <C> 创建或修改请求参数类型
* @author Charles7c * @author Charles7c
* @since 1.0.0 * @since 1.0.0
*/ */