Springboot 中集成 swagger笔记

1. 首先maven 添加依赖 (版本自行选择)

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

swagger配置类

package com.es.esservice.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;


/**
 * @auther:Wangxl
 * @Emile:18335844494@163.com
 * @Time:2020/4/16 10:54
 */
@Configuration
@EnableSwagger2
public class SwaggerConfiguration
{
    @Bean
    public Docket createRestApi()
    {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors
                .basePackage("com.es.esservice.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo()
    {
        return new ApiInfoBuilder().title("elasticsearch APIs").description("王晓龙 APIs").version("1.0")
                .build();
    }
}

basePackage( "这里填你们controller的路径")

访问 http://localhost:8080/swagger-ui.html

常用注解

• @Api()用于类；

表示标识这个类是swagger的资源

• @ApiOperation()用于方法；

表示一个http请求的操作

• @ApiParam()用于方法，参数，字段说明；

表示对参数的添加元数据（说明或是否必填等）

• @ApiModel()用于类

表示对类进行说明，用于参数用实体类接收

• @ApiModelProperty()用于方法，字段

表示对model属性的说明或者数据操作更改

• @ApiIgnore()用于类，方法，方法参数

表示这个方法或者类被忽略

• @ApiImplicitParam() 用于方法

表示单独的请求参数

• @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

具体使用举例说明：
@Api()
用于类；表示标识这个类是swagger的资源
tags–表示说明
value–也是说明，可以使用tags替代

@ApiOperation() 用于方法；表示一个http请求的操作
value用于方法描述