swagger2线上文档

一、导包（个人觉得2.7版本比较简洁，2.8以上界面不一样）

<!--swagger2线上文档 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

二、建SwaggerConfig文件

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiModel;
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.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.swagger.web.UiConfiguration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.admin.sell"))
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("售卖商城")
                .description("系统接口文档说明")
                .contact(new Contact("admin", "", ""))
                .version("1.0")
                .build();
    }

    @Bean
    UiConfiguration uiConfig() {
        return new UiConfiguration(null, "list", "alpha", "schema",
                UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS, false, true, 60000L);
    }
}

三、注解

import com.lsj.sell.pc.model.Product;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/hello")
@Api(tags = {"你好，世界"})
public class HelloController {

    @PostMapping("/index")
    @ResponseBody
    @ApiOperation(value = "你好世界首页", notes = "事实说明")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "用户名", required = true, dataType = "String",paramType = "query"),
            @ApiImplicitParam(name = "password", value = "密码(六位数)", required = true, dataType = "String",paramType = "query"),
            @ApiImplicitParam(name = "age", value = "年龄", required = true, dataType = "int",paramType = "query")
    })
    public String index(String name,String password,Integer age){
        if(name.isEmpty()||password.isEmpty()){
            return "false";
        }else{
            if(age==null){
                return "false";
            }
            return name+":"+age;
        }
    }

    @PostMapping("/login")
    @ResponseBody
    @ApiOperation(value = "登录页面", notes = "事实说明")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "用户名", required = true, dataType = "String",paramType = "query"),
            @ApiImplicitParam(name = "password", value = "密码(六位数)", required = true, dataType = "String",paramType = "query")
    })
    public Product login(String name, String password,Product product){
        return new Product();
    }
}

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;

import java.math.BigDecimal;

@Data
@ApiModel(description= "产品信息")
public class Product {
    private Integer id;
    @ApiModelProperty(value = "产品名称", required = true)
    private String productName;
    @ApiModelProperty(value = "产品价格", required = true)
    private BigDecimal productPrice;
    @ApiModelProperty(value = "产品颜色")
    private String color;
    @ApiModelProperty(value = "产品描述")
    private String description;
}

界面地址：http://localhost/swagger-ui.html