SpringBoot框架集成springfox-swagger-ui

Swagger接口文档对于平时开发而言,无论是前段还是后端,都是非常不错的文档工具,现在就讲讲Springboot怎么快速的集成Swagger,话不多说,直接上代码,

引入必要jar

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
      <scope>provided</scope>
</dependency>

 <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger-ui</artifactId>
       <scope>provided</scope>
</dependency>

第一步:创建url配置累

import com.chinacoal.microservice.config.RestTemplateUrlConfig;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * url配置类
 */
@Configuration//扫描注解,提供被Spring加载
public class RestTemplateUrlConfiguration {

    @Bean
    @ConfigurationProperties(prefix="delivery")
    public RestTemplateUrlConfig urlConfigByDelivery(){
        return new RestTemplateUrlConfig();
    }

}

第二步:创建Swagger配置类

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

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).groupName("业务管理")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.*****.*****.controller"))//指定的API包,可以是controller,可以是专门的对外接口,列如:com.base.zijie.controller,根据实际情况而言
                .build();
    }


        private ApiInfo apiInfo () {
            return new ApiInfoBuilder()
                    .title("swagger RESTful APIs")
                    .description("swagger RESTful APIs").termsOfServiceUrl("http://www.test.com/")
                    .version("1.0")
                    .build();
        }

    }

第三步:启动项目,访问 localhost:8080/doc.html

                这里的8080是项目的对外端口号

可查看端口,可进行端口测试,方便快捷

 


版权声明:本文为weixin_37999518原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。