Swagger-UI是HTML, Javascript, CSS的一个集合,可以动态地根据注解生成在线API文档
常见注释
@Api 用于修饰Controller类,生成Controller相关文档信息
@ApiOperation 用于修饰Controller类中的方法
@ApiParam 用于修饰接口中的参数
@ApiModelProperty 用于修饰实体类的属性
整合Swagger-ui
项目依赖
swagger配置
Swagger对生成API文档的范围有三种不同的选择
生成指定包下面的类的API文档
生成有指定注解的类的API文档
生成有指定注解的方法的API文档
当前展示为指定包下的API文档
为有@Api注解的Controller生成API文档为
.apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
为有@ApiOperation注解的方法生成API文档为
.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))