mirror of
https://github.com/continew-org/continew-starter.git
synced 2025-09-08 16:57:09 +08:00
style: 统一请求参数、响应参数注释
This commit is contained in:
@@ -45,7 +45,7 @@ import java.util.List;
|
||||
* @param <L> 列表类型
|
||||
* @param <D> 详情类型
|
||||
* @param <Q> 查询条件
|
||||
* @param <C> 创建或修改参数类型
|
||||
* @param <C> 创建或修改请求参数类型
|
||||
* @author Charles7c
|
||||
* @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
|
||||
*/
|
||||
@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
|
||||
*/
|
||||
@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)
|
||||
@Operation(summary = "删除数据", description = "删除数据")
|
||||
|
@@ -23,13 +23,13 @@ import java.io.Serializable;
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* 分页信息
|
||||
* 分页响应参数
|
||||
*
|
||||
* @param <T> 列表数据类型
|
||||
* @author Charles7c
|
||||
* @since 2.5.2
|
||||
*/
|
||||
@Schema(description = "分页信息")
|
||||
@Schema(description = "分页响应参数")
|
||||
public class BasePageResp<T> implements Serializable {
|
||||
|
||||
@Serial
|
||||
|
@@ -21,7 +21,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
|
||||
import java.io.Serializable;
|
||||
|
||||
/**
|
||||
* ID 响应信息
|
||||
* ID 响应参数
|
||||
*
|
||||
* @author Charles7c
|
||||
* @since 2.5.0
|
||||
|
@@ -23,13 +23,13 @@ import java.io.Serial;
|
||||
import java.io.Serializable;
|
||||
|
||||
/**
|
||||
* 键值对信息
|
||||
* 键值对响应参数
|
||||
*
|
||||
* @param <T>
|
||||
* @author Charles7c
|
||||
* @since 2.1.0
|
||||
*/
|
||||
@Schema(description = "键值对信息")
|
||||
@Schema(description = "键值对响应参数")
|
||||
public class LabelValueResp<T> implements Serializable {
|
||||
|
||||
@Serial
|
||||
|
@@ -31,7 +31,7 @@ import java.util.List;
|
||||
* @param <L> 列表类型
|
||||
* @param <D> 详情类型
|
||||
* @param <Q> 查询条件
|
||||
* @param <C> 创建或修改参数类型
|
||||
* @param <C> 创建或修改请求参数类型
|
||||
* @author Charles7c
|
||||
* @since 1.0.0
|
||||
*/
|
||||
@@ -90,7 +90,7 @@ public interface BaseService<L, D, Q, C> {
|
||||
/**
|
||||
* 创建
|
||||
*
|
||||
* @param req 创建参数
|
||||
* @param req 创建请求参数
|
||||
* @return 自增 ID
|
||||
*/
|
||||
Long create(C req);
|
||||
@@ -98,7 +98,7 @@ public interface BaseService<L, D, Q, C> {
|
||||
/**
|
||||
* 修改
|
||||
*
|
||||
* @param req 修改参数
|
||||
* @param req 修改请求参数
|
||||
* @param id ID
|
||||
*/
|
||||
void update(C req, Long id);
|
||||
|
@@ -59,7 +59,7 @@ import java.util.Optional;
|
||||
* @param <L> 列表类型
|
||||
* @param <D> 详情类型
|
||||
* @param <Q> 查询条件
|
||||
* @param <C> 创建或修改参数类型
|
||||
* @param <C> 创建或修改请求参数类型
|
||||
* @author Charles7c
|
||||
* @since 1.0.0
|
||||
*/
|
||||
|
Reference in New Issue
Block a user