Swagger2接口文档功能

1、引入pom

<!-- Swagger2接口文档 -->
<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>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.8.7</version>
</dependency>

2、配置类

package com.itennishy.ycweb.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;

@Configuration
@EnableSwagger2
public class Swagger2 {

    /**
     * 接口文档
     * http://localhost:8088/swagger-ui.html
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.itennishy.ycweb.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("iTennis Taobao Restful APIs")
                .description("益采淘宝直播信息接口")
                .version("1.0")
                .build();
    }

}

3、常用注解

@ApiOperation(value = "粉丝成份", notes = "获取直播中粉丝成份")
@ApiImplicitParam(name = "liveid", value = "直播id", dataType = "String", required = true)
@ApiResponses(value = {
        @ApiResponse(code = 200, message = "OK"),
        @ApiResponse(code = 20001, message = "参数错误"),
        @ApiResponse(code = 20002, message = "你访问的太快了,请稍后再试!"),
        @ApiResponse(code = 20003, message = "没有这场直播信息!"),
        @ApiResponse(code = 20004, message = "正在疯狂加载中,请稍后再试!"),
})

来源：CSDN

作者：iT执行人

链接：https://blog.csdn.net/u014789086/article/details/103462472

标签

swagger

springfox