springBoot Swagger2 接口文档生成

最新推荐文章于 2024-12-15 14:06:40 发布

转载最新推荐文章于 2024-12-15 14:06:40 发布 · 124 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/leigepython/p/10562934.html

文章标签：

#java

本文介绍了一种使用Spring Boot和Swagger2自动生成接口文档的方法。通过配置Swagger2，可以详细记录并展示项目的API信息，包括标题、描述、版本、联系信息等。此配置适用于IRM全局API文档的自动生成。

// 生成配置类
package com.irm.jd.config.swagger;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

/**
 * 接口文档自动生成配置
 */
@Configuration
public class Swagger2Config {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.irm.jd.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("IRM 全局API文档")
                .description("IRM 全局API文档，http://irm.jd.com")
                .termsOfServiceUrl("http://irm.jd.com")
                .version("1.0.0")
                .build();
    }
}

//开启
@SpringBootApplication()
@EnableCaching
@EnableScheduling
@MapperScan("com.irm.jd.mapper")
@EnableAsync
@EnableSwagger2
public class IrmApplication extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
        return application.sources(IrmApplication.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(IrmApplication.class, args);
    }
}

// 方法上面定义
 @PostMapping("/upload")
    @ApiOperation(value = "脚本上传")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "files",value = "上传的文件",type ="file",paramType = "path",required =true)
    })
    public String uploadScript(List<MultipartFile> files) {
        for (MultipartFile file : files) {
            System.out.println(file);
        }
        return null;
    }

转载于:https://www.cnblogs.com/leigepython/p/10562934.html