knife4j及一些api注解说明

@ApiModel(description = "考试报名参数")

/**
 *用于类 
 *表示对类进行说明，用于参数用实体类接收
 *
 *value–表示对象名 
 *description–描述
 */
@ApiModel(value="user对象",description="用户对象user")
public class User implements Serializable{
    private static final long serialVersionUID = 1L;
     @ApiModelProperty(value="用户名",name="username",example="xingguo")
     private String username;
     @ApiModelProperty(value="状态",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;
 
      @ApiModelProperty(value="id数组",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}

@ApiModelProperty("考试地点 id")

/**
 *用于类字段 
 *表示对model属性的说明或者数据操作更改
 *
 *value–字段说明 
 *name–重写属性名字 
 *dataType–重写属性类型 
 *required–是否必填 
 *example–举例说明 
 *hidden–隐藏
 */

@Api

/**
 *一般用于控制层的类
 *表示标识这个类是swagger的资源 
 *
 *tags–表示说明 
 *value–也是说明，可以使用tags替代 
 *但是tags如果有多个值，会生成多个list
 */
@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class UserController {
}

@ApiOperation("新增用户统计")

/**
 *一般用于控制层的类中的方法
 *表示一个http请求的操作 
 *
 *value用于方法描述 
 *notes用于提示内容 
 *tags可以重新分组（视情况而用）
 */
@Api(value="用户controller",tags={"用户操作接口"})
@RestController
public class UserController {
     @ApiOperation(value="获取用户信息",tags={"获取用户信息copy"},notes="注意问题点")
     @GetMapping("/getUserInfo")
     public User getUserInfo(@ApiParam(name="id",value="用户id",required=true) Long id,@ApiParam(name="username",value="用户名") String username) {
     // userService可忽略，是业务逻辑
      User user = userService.getUserInfo();
      return user;
  }
}

@ApiParam

/**
 *一般用于控制层的类中的方法的，参数，字段说明； 
 *表示对参数的添加元数据（说明或是否必填等）
 *
 *name–参数名 
 *value–参数说明 
 *required–是否必填
 */

详细请转

swagger注解详解

knife4j官方文档

在spring boot中需要引入依赖

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
    <!--在引用时请在maven中央仓库搜索最新版本号-->
    <version>2.0.4</version>
</dependency>
<!-- 还需要加入数据校验的依赖，不然会报错 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

在spring boot使用knife4j还需要写一个配置类

@Configuration
@EnableSwagger2  //该注解是Springfox-swagger框架提供的使用Swagger注解，该注解必须加
@EnableKnife4j   //该注解是knife4j提供的增强注解,Ui提供了例如动态参数、参数过滤、接口排序等增强功能,如果你想使用这些增强功能就必须加该注解，否则可以不用加
@Import(BeanValidatorPluginsConfiguration.class)
public class SwaggerConfiguration {
 

    @Bean(value = "defaultApi2")
    public Docket defaultApi2() {
        Docket docket=new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组名称
                .groupName("2.X版本")
                .select()
                //这里指定Controller扫描包路径
                //配置扫描，所有想要在swagger界面统一管理的接口，都必须在此包下
                .apis(RequestHandlerSelectors.basePackage("com.swagger.bootstrap.ui.demo.new2"))
                .paths(PathSelectors.any())
                .build();
        return docket;
    }
    
    
   @Bean
    public ApiInfo apiInfo() {
        Contact contact = new Contact("陈力", "https://bilibili.com", "2413013267@qq.com");
        return new ApiInfoBuilder()
                .title("设置文档标题")
                .description("设置文档描述")
                .termsOfServiceUrl("https://bilibili.com")//设置服务Url
                .contact(contact)
                .version("2.3.1")//设置文档版本号
                .build();
    }
    
}

说明一下，在Google Chrome上访问的地址为

localhost:8080/doc.html