springboot集成swagge3 很方便

一、pom文件中引入Swagger3依赖

<dependency>
     <groupId>io.springfox</groupId>
      <artifactId>springfox-boot-starter</artifactId>
      <version>3.0.0</version>
</dependency>

二、Application上面加入@EnableOpenApi注解

/**
 * @author nuiiqk
 */
@SpringBootApplication
@EnableOpenApi
public class FileApplication {

    public static void main(String[] args) {
        TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"));
        SpringApplication.run(FileApplication.class, args);
    }

    /**
     * 设置时区
     */
    @PostConstruct
    void setDefaultTimezone() {
        TimeZone.setDefault(TimeZone.getTimeZone("Asia/Shanghai"));
    }

}

三、Swagger3Config的配置

@Configuration
public class Swagger3Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 文档访问地址： http://localhost:9002/swagger-ui/index.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger3-附件接口文档")
                .description("简单优雅的restful风格")
                .contact(new Contact("NuiiQK","nuii.site","nuiiqk@qq.com"))
                .version("1.0")
                .build();
    }
}

四、Swagger注解的使用说明

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · div（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性

五、Controller层的配置

/**
 * @author NuiiQK
 * @date 2020-12-30
 **/
@RestController
@RequestMapping("file")
@Api(value = "文件服务相关接口", tags = {"文件服务相关接口"})
@Slf4j
public class FileController {


    /**
     * 通用上传请求
     *
     */
    @ApiOperation(value = "文件上传", notes = "文件上传")
    @PostMapping(value = "/upload")
//    @ApiImplicitParams({@ApiImplicitParam(name = "file", value = "文件数据", required = true, dataType = "MultipartFile")})
    public ObjectResult upload(MultipartFile file, HttpServletRequest request) {

    }

    /**
     * 本地资源通用下载
     * 
     * @param url http://ip:9002/profile/base/common/jpg/2021/1/6/1609927195871.jpg
     * @param request
     * @param response
     * @throws Exception
     */
    @ApiOperation(value = "本地资源通用下载", notes = "本地资源通用下载")
    @GetMapping("/download/resource")
    @ApiImplicitParams({@ApiImplicitParam(name = "url", value = "文件请求路径", required = true, dataType = "String")})
    public void resourceDownload(String url, HttpServletRequest request, HttpServletResponse response)
        throws Exception {
     
    }

}

六、Swagger界面效果