SpringBoot集成Swagger

最近项目与前端对接时开始接触Swagger。

Swagger：一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

用法：

一、添加依赖包

<!--pom.xml文件-->
        <!--swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

二、添加配置类 ：Swagger2Config

package com.cdqyzj.admin.system.config;

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

/*
 * Swagger2配置类
 * 在与spring boot集成时，放在与Application.java同级的目录下。
 * 通过@Configuration注解，让Spring来加载该类配置。
 * 再通过@EnableSwagger2注解来启用Swagger2。
 */
@EnableSwagger2
@Configuration
public class Swagger2Config {
    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     * @return
     */

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
               // .apis(RequestHandlerSelectors.basePackage("com.swaggerTest.controller"))
                //为当前包路径
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        		//页面标题
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                //
                // .termsOfServiceUrl("http://www.baidu.com")
                //创建人
                .contact("我啥时候写了这玩意儿啊？9月29日我都还不知道Swagger2是个啥玩意儿")
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

三、在接口处添加注解

//附加税
@Controller
@RequestMapping("/addTax")
@Api(value = "AddtaxController|一个关于附加税的控制器")
public class AddtaxController {

	public final String prefix = "WeChat_Files/backstage_Files/manage_AddTax";
	
	@Autowired
	private AddtaxService addtaxService;
	@Autowired
	private UCompanyService ucomService;

	...
    
	@ResponseBody
	@RequestMapping(value="/list_user/{userId}/{year}/{taxType}",method=RequestMethod.GET)
	@ApiOperation(value="根据用户ID、具体年份和税务类型获取具体附加税信息", notes="test: 税务类型包括：季报 月报")
        @ApiImplicitParams({
            @ApiImplicitParam(paramType="query", name = "userId", value = "用户ID", required = true, dataType = "Integer"),
            @ApiImplicitParam(paramType="query", name = "year", value = "税务时间", required = true, dataType = "String"),
            @ApiImplicitParam(paramType="query", name = "taxType", value = "税务类型", required = true, dataType = "String")
        })
	public PageUtil list_user(@PathVariable("userId")int userId,@PathVariable("year")int year,@PathVariable("taxType")String taxType){
		System.err.println("按用户查全部:userId:"+userId+"\tyear:"+year+"\t taxType:"+taxType);
		List<Addtax> rows;
		PageUtil page = new PageUtil();
		...
           具体解决方法
        ...
		page.setRows(rows);
		page.setTotal(total);
		return page;
	}
	

四、在浏览器中访问，地址为：http://127.0.0.1/swagger-ui.html

五、Swagger使用的注解及其说明

@Api：用在类上，说明该类的作用。

@ApiOperation：注解来给API增加方法说明。

@ApiImplicitParams : 用在方法上包含一组参数说明。

@ApiImplicitParam：用来注解来给方法入参增加说明。

@ApiResponses：用于表示一组响应

@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

    l   code：数字，例如400

    l   message：信息，例如"请求参数没填好"

    l   response：抛出异常的类   

@ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）

    l   @ApiModelProperty：描述一个model的属性

 

最后，附上传送门：Swagger官网 ：http://swagger.io/