项目相关注解 | 易学教程

@Id 
private String pageId;

@Id 标注用于声明一个实体类的属性映射为数据库的主键列

@Data 
@ToString
 @Document(collection = "cms_page") 
 public class CmsPage

@Data、@ToString：是Lombok提供的注解，@Data注解可以自动生成getter/setter方法，@ToString生成tostring方法。
@Document：是Spring Data mongodb提供的注解，最终CMS的开发会使用Mongodb数据库。

@SpringBootApplication //声明为springboot应用
@EntityScan("com.xuecheng.framework.domain.cms")//扫描实体类 
@ComponentScan(basePackages={"com.xuecheng.api"})//扫描接口 
@ComponentScan(basePackages={"com.xuecheng.manage_cms"})//扫描本项目下的所有类 
public class ManageCmsApplication

Spring Boot应用需要创建一个应用启动类，启动过程中会扫描Bean并注入spring 容器

@SpringBootTest 
@RunWith(SpringRunner.class) 
public class CmsPageRepositoryTest

测试程序使用@SpringBootTest和@RunWith(SpringRunner.class)注解，启动测试类会从main下找springBoot启动类，加载spring容器。
注意： $\color{#FF0000}{test下的包路径与main下的包路径保持一致。}$

@Api(value="cms页面管理接口",description = "cms页面管理接口，提供页面的增、删、改、查")
public interface CmsPageControllerApi {
    //页面查询
    @ApiOperation("分页查询页面列表")
    @ApiImplicitParams({
            @ApiImplicitParam(name="page",value = "页码",required=true,paramType="path",dataType="int"),
            @ApiImplicitParam(name="size",value = "每页记录数",required=true,paramType="path",dataType="int")
    })
    public QueryResponseResult findList(int page, int size, QueryPageRequest queryPageRequest);

Swagger中常用注解：
在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下：

@Api：修饰整个类，描述Controller的作用 
@ApiOperation：描述一个类的一个方法，或者说一个接口 
@ApiParam：单个参数描述 
@ApiModel：用对象来接收参数 
@ApiModelProperty：用对象接收参数时，描述对 象的一个字段 
@ApiResponse：HTTP响应其中1个描述 
@ApiResponses：HTTP响应整体描述 
@ApiIgnore：使用 该注解忽略这个API 
@ApiError ：发生错误返回的信息 
@ApiImplicitParam：一个请求参数 
@ApiImplicitParams：多个请求参数

来源：CSDN

作者：꧁༺Rsun༻꧂

链接：https://blog.csdn.net/yang_guang3/article/details/104797738

标签

class