swagger使用

1、引入依赖

        model和common模块中引入以下依赖

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

2、common工程中添加配置类 SwaggerConfiguration

package com.heima.common.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 SwaggerConfiguration {

    @Bean
    public Docket buildDocket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInfo())
                .select()
                // 要扫描的API(Controller)基础包
                .apis(RequestHandlerSelectors.basePackage("com.heima"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo buildApiInfo() {
        Contact contact = new Contact("黑马程序员","","");
        return new ApiInfoBuilder()
                .title("黑马头条-平台管理API文档")
                .description("黑马头条后台api")
                .contact(contact)
                .version("1.0.0").build();
    }
}

 3、在resources目录中新增以下目录和文件

        文件：resources/META-INF/Spring.factories  

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.heima.common.swagger.SwaggerConfiguration

 4、Swagger常用注解

        在Java类中添加Swagger的注解即可生成Swagger接口文档，常用Swagger注解如下：

        @Api：修饰整个类，描述Controller的作用

        @ApiOperation：描述一个类的一个方法，或者说一个接口

        @ApiParam：单个参数的描述信息

        @ApiModel：用对象来接收参数

        @ApiModelProperty：用对象接收参数时，描述对象的一个字段

        @ApiResponse：HTTP响应其中1个描述

        @ApiResponses：HTTP响应整体描述

        @ApiIgnore：使用该注解忽略这个API

        @ApiError ：发生错误返回的信息

        @ApiImplicitParam：一个请求参数

        @ApiImplicitParams：多个请求参数的描述信息