SpringBoot整合Swagger

SpringBoot整合Swagger

号称世界上最流行的Api框架

RestFuol Api 文档在线自动生成工具

直接运行，在线测试Api接口

支持多种语言

导入依赖

• 新建一个springBoot的web项目

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.0</version>
</dependency>

注入配置

package cn.zzzyuan.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {


}

创建基本接口

package cn.zzzyuan.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @RequestMapping(value = "/hello")
    public String hello(){
        return "hello";
    }

}

启动项目

• 访问http://localhost:8080/swagger-ui.html

  

Swagger的基本配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo( new ApiInfo("标题",
                        "描述",
                        "版本号",
                        "队伍服务器URL",
                         new Contact("作者","作者URL","邮箱"),
                        "Apache 2.0",
                        "http://www.apache.org/licenses/LICENSE-2.0",
                        new ArrayList()
                ));
    }
}

自定义配置扫描接口

package cn.zzzyuan.config;

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

import java.util.ArrayList;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo( new ApiInfo("easyBlog",
                        "一款个性化博客的后端接口",
                        "1.0",
                        "无",
                        new Contact("杂货猿","blog.zzzyuan.cn","codesuperman@foxmail.com"),
                        "Apache 2.0",
                        "http://www.apache.org/licenses/LICENSE-2.0",
                        new ArrayList()
                )).select()
                // 指定扫描方式RequestHandlerSelectors ，
               //basePackage 指定扫描的包
            	// any 全部 ，none 不扫描 。
               //withClassAnnotation 扫描类上的注解,withCMethodAnnotation
                .apis(RequestHandlerSelectors.basePackage("cn.zzzyuan.controller"))
            	// 过滤path下的包
               .path(PathSelectors.an(path))
                .build();

    }
}