Swagger接口文档生成

pom文件修改

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

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

新增配置类

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.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 SwaggerConfig {
    @Bean
    public Docket productApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo()).select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)).build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("ilabservice example service")
                .description("example service to manage device")
                .version("1.0")
                .build();
    }
}

使用

常用注解

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
 
 
@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"
 
 
@ApiImplicitParams：用在请求的方法上，表示一组参数说明
    @ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值
 
 
@ApiResponses：用在请求的方法上，表示一组响应
    @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类
 
 
@ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
    @ApiModelProperty：用在属性上，描述响应类的属性
        value–字段说明 
        name–重写属性名字 
        dataType–重写属性类型 
        required–是否必填 
        example–举例说明 
        hidden–隐藏

Controller类

/**
 * @Classname HomePageService
 * @Description TODO
 * @Date 2019/10/29 9:52
 * @Created zzf
 */
@RestController
@RequestMapping("/user/base/home")
@Api(value = "home", description = "首页相关接口", tags = {"home"})
public interface HomePageService {


    @ApiOperation(value = "获取首页轮播图", notes = "获取首页轮播图")
    @ApiResponses({
            @ApiResponse(code = 400, message = "参数非法"),
            @ApiResponse(code = 500, message = "服务器错误"),
            @ApiResponse(code = 200, message = "成功")
    })
    @ApiImplicitParams({
            @ApiImplicitParam(name = "bizType", value = "业务类型", dataType = "String", paramType = "path", required = true),
    })
    @GetMapping("/getSlideshow/{bizType}")
    CommonPageResult<List<Slideshow>> getSlideshow(@PathVariable("bizType") String bizType);
}

Model类

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

/**
 * 首页轮播图
 *
 * @Classname Slideshow
 * @Description TODO
 * @Date 2019/10/29 9:45
 * @Created zzf
 */
@Data
@ApiModel(value = "slideshow")
@TableName("slideshow")
public class Slideshow {

    @ApiModelProperty(value = "轮播图id", example = "1", dataType = "int")
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 图片
     */
    @ApiModelProperty(value = "轮播图url", example = "XXX.jpg", dataType = "String")
    @TableField(value = "picture")
    private String picture;

    /**
     * 排序
     */
    @ApiModelProperty(value = "排序号", example = "排序号", dataType = "Integer")
    @TableField(value = "sort")
    private Integer sort;


    /**
     * biztype
     */
    @ApiModelProperty(value = "业务类型", example = "1", dataType = "Integer")
    @TableField(value = "biz_type")
    private String bizType;
}

启动后访问:http://localhost:XXX/swagger-ui.html