Swagger2 使用

Swagger 依赖

	compile "io.springfox:springfox-swagger2:2.7.0"
	compile "io.springfox:springfox-swagger-ui:2.7.0"

Swagger配置类

package com.uxsino.institutionDesign.config;/**

import com.fasterxml.classmate.TypeResolver;
import com.uxsino.commons.utils.StringUtils;
import io.swagger.annotations.ApiOperation;
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
//开启Swagger2功能
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 创建API应用
     * apiInfo() 增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     * 本例采用指定扫描的包路径来定义指定要建立API的目录。
     *
     * @return
     */
    @Bean
    public Docket createRestApi(){
        //版本类型是swagger2
        return new Docket(DocumentationType.SWAGGER_2)
                //通过调用自定义方法apiInfo，获得文档的主要信息
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.uxsino.institutionDesign.controller"))//扫描该包下面的API注解
                .paths(PathSelectors.any())
                .build();
    }
    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("制度管理") //接口管理文档首页显示
                .description("制度管理功能")//API的描述
                .version("1.0")
                .build();
    }
}

访问地址

	访问地址：http://localhost:8080/swagger-ui.html

效果图：

Swagger 注解的使用

属性上的注解

	@ApiModelProperty(value="状态",dataType="com.uxsino.enum.status")
	private enum status;

实体类上的注解

	@ApiModel(value = "ppp",description="产品模型")

控制器上的注解

	@Api(tags= "项目管理")

效果图：

Controller方法上

	@Apioperation(value = "查询单条制度",notes = "根据ID查询制度")

效果图：