配置生成swagger文档(基础版)

一.添加依赖

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

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

二.编写配置类

@Configuration//托管spring
@EnableSwagger2//开启swagger功能
public class SwaggerConfig {
/**
 * 创建API应用
 * apiInfo() 增加API相关信息
 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
 * 本例采用指定扫描的包路径来定义指定要建立API的目录。
 *
 * @return 创建该API的基本信息（这些基本信息会展现在文档页面中）
 * 访问地址：http://项目实际地址/swagger-ui.html
 * @return
 */

    @Bean
    public Docket createRestApi(){
        //版本类型是swagger2
        return new Docket(DocumentationType.SWAGGER_2)
                //通过调用自定义方法apiInfo，获得文档的主要信息
                .apiInfo((apiInfo()))
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.dp.om_fw.controller"))//扫描该包下面的API注解
                .paths(PathSelectors.any())
                .build();
    }
/**
 * 创建该API的基本信息（这些基本信息会展现在文档页面中）
 * 访问地址：http://项目实际地址/swagger-ui.html
 * @return
 */

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("使用Swagger2 构建RESTful APIS - zy") //接口管理文档首页显示
                .description("zy - Swagger使用演示")//API的描述
                .termsOfServiceUrl("www.footmark.top")//网站url等
                .version("1.0")
                .build();
    }
}

三.添加注解

1.在需要生成的文档的类上加@API注解,在类中需要生成接口文档的方法上加@ApiOperation注解(一般在controller层);

2.在文档中生成实体类时,在类上添加@ApiModel,在实体类的属性上添加@ApiModelProperty.