Swagger 文档使用配置

Swagger 文档使用配置

1.pom.xml 文件配置

        <!--swagger-API-->
        <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>

在项目的pom.xml文件中加入Swagger的配置

2.编写swagger配置类

package com.cams.cloud.classroom.util;


import io.swagger.annotations.SwaggerDefinition;
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;

@Configuration
@EnableSwagger2
public class SwaggerUtil {


    /**
     * 创建API应用
     * apiInfo()增加API相关信息
     * 通过select()函数返回一个ApiSelectorBuilder实例，用来控制那些接口暴露给Swagger来展现
     * 本例采用指定扫描的包路径来定义指定要建立API的目录
     */

    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.cams.cloud.classroom.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     *
     */
    public ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .description("swagger文档")
                .termsOfServiceUrl("")
                .contact("lcl")
                .version("1.0")
                .build();
    }

}

3.相关注解

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

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

• @ApiImplicitParams : 用在方法上包含一组参数说明。
  | paramType：指定参数放在哪个地方 | header：请求参数放置于Request Header，使用@RequestHeader获取
  query：请求参数放置于请求地址，使用@RequestParam获取
  path：（用于restful接口）–>请求参数的获取：@PathVariable
  body：（不常用）
  form（不常用） |
  | name：参数名| |
  | dataType：参数类型 | true | false |
  | required：参数是否必须传| |
  | value：说明参数的意思 | |
  | defaultValue：参数的默认值| |

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

• @ApiResponses：用于表示一组响应

• @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
  l code：数字，例如400
  l message：信息，例如"请求参数没填好"
  l response：抛出异常的类

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