zoukankan      html  css  js  c++  java
  • springBoot Swagger2 接口文档生成

    // 生成配置类
    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;
        }
  • 相关阅读:
    开源项目之Android StandOut(浮动窗口)
    小智慧7
    安卓学习
    asp.net学习Request和Response的其他属性
    bash中的转义
    POJ 1833 排列
    Django点滴(四)ORM对象存取
    POJ 1681 Painter's Problem
    linux2.6.32在mini2440开发板上移植(21)之WebServer服务器移植
    [gkk传智]static与多态及向下向上转型,及多态调用总结
  • 原文地址:https://www.cnblogs.com/leigepython/p/10562934.html
Copyright © 2011-2022 走看看