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 才能訪問到。