给swagger的接口添加描述

最新推荐文章于 2025-10-26 21:31:27 发布

原创

最新推荐文章于 2025-10-26 21:31:27 发布 · 5.9k 阅读

3 ·

CC 4.0 BY-SA版权

文章标签：

#swagger #接口描述 #前后端分离

swgger非常便于前后端分离开发，通过给swagger添加描述就可以实现前后端共同的开发接口，以下介绍如何给swagger的接口添加描述。

一.创建实体，并在实体和属性上使用@ApiModel()、@ApiModelProperty()注解。

注解的具体文档请参考https://blog.youkuaiyun.com/dejunyang/article/details/89527348

1.1 工作者实体

//工作者实体
import com.alibaba.fastjson.annotation.JSONField;
import com.baomidou.mybatisplus.annotations.TableField;
import com.baomidou.mybatisplus.annotations.TableId;
import com.baomidou.mybatisplus.annotations.TableName;
import com.baomidou.mybatisplus.enums.IdType;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotEmpty;
import java.util.Date;
import java.util.List;

@Data
@TableName("XXW_WORKER_T")
@ApiModel("工作者实体")
public class XxwWorkerT extends FieldFillBean {
    /**
     * 主键
     */
    @TableId(value = "XXW_WORKER_ID", type = IdType.UUID)