SpringBoot Swagger

SpringBoot整合Swagger

本文章是SpringBoot对Swagger的简单整合

引入整合Swagger的依赖:
基于能够访问Web的SpringBoot项目

		<!-- 配置swagger2 -->
		 <dependency>  
            <groupId>io.springfox</groupId>  
            <artifactId>springfox-swagger2</artifactId>  
            <version>2.7.0</version>  
        </dependency>  
        <dependency>  
            <groupId>io.springfox</groupId>  
            <artifactId>springfox-swagger-ui</artifactId>  
            <version>2.7.0</version>  
        </dependency>

添加Swagger的Config类:

package com.example.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
		//http://localhost:8080/swagger-ui.html
	 	@Bean
	    public Docket docket(){
	        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
	        		//	                   当前包路径
	                   .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
	                    .paths(PathSelectors.any()).build();
	    }
	 	
	 	//构建api文档的详细信息函数
	    private ApiInfo apiInfo(){
	        return new ApiInfoBuilder()
	                //页面标题
	                    .title("Swagger2构建RESTful API")
	                //创建人
	                    .contact(new Contact("Leay Lu","https://blog.csdn.net/l13568","欢迎访问"))
	                 //版本号
	                    .version("1.0")
	                //描述
	                    .description("API 描述")
	                    .build();
	    }
}

访问Swagger的API网页:
访问: http://127.0.0.1:8080/swagger-ui.html