Swagger的运用

第一步 配置Swagger

1.导入jar包到pom.xml文件里

 <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
   </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

2.新建config包，在这个包下建一个SwaggerConfig类

package com.hp.deal.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
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 createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("张葫芦")
                .enable(true)//Swagger是否自动启动
                .select()
                .apis(RequestHandlerSelectors.any())//扫描所有包
                //.paths(PathSelectors.any())//过滤什么路径
                .build();
    }

    private  ApiInfo apiInfo(){
//        return new ApiInfoBuilder().build();



        //配置作者信息
      Contact contact=  new Contact("张葫芦", "#", "#");

        return new ApiInfo("张葫芦的Swagger文档",
             "勤能补拙",
             "1.0",
             "urn:tos",
                contact,
             "Apache 2.0",
             "http://www.apache.org/licenses/LICENSE-2.0",
             new ArrayList());


    }
}

3.注释的使用
实体类中：
@ApiModel(“用户实体类”) 用来给实体类起个别名
@ApiModelproperty(" ") 用来给属性起别名
Controller中：
@ApiOperation(“用户控制器”) 用来给Controller注释（放在方法上）

4.出现的问题：
配置完成以后 访问 localhost:8080/swagger-ui/html 出现404
遇到这种情况，首先查看application.yml文件中是否配置了启动路径，比如
所以要加上/deal 才能访问到。