Swagger安装和LocalDate入参

目录

1、swagger2安装

1.1 引入swagger2依赖

1.2 config文件配置

1.3 控制器上加@Api，方法上加@ApiOperation

1.4 访问swagger界面

2、入参

2.1 传递日期报错，无法正常解析；

---

1、swagger2安装

1. pom文件引入swagger2依赖；
2. config文件配置扫描控制器；
3. 控制器中引入相关注解；
4. 访问swagger界面

1.1 引入swagger2依赖

直接从网上抄的，也可以自己从maven仓库去找；

        <!--添加Swagger依赖 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <!--添加Swagger-UI依赖 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

1.2 config文件配置

注意配置要扫描的控制器，不然直接复制，扫描不到你的控制器

package com.xky.mybatisplus.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

// 标记配置类
@Configuration
// 开启在线接口文档
@EnableSwagger2
public class Swagger2Config {

    /**
     * @Description: swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()
                // 配置到项目的controller包
                .apis(RequestHandlerSelectors.basePackage("com.xky.mybatisplus.controller"))
                .paths(PathSelectors.any()).build();
    }

    /**
     * @Description: 构建api文档的信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("xxx项目文档标题")
                .description("xxx项目文档描述")
                .contact(new Contact("xxx开发者称呼", "xxx.com网站", "xxx@qq.com邮箱"))
                // 定义版本号
                .version("版本号:xx.x").build();
    }
}

1.3 控制器上加@Api，方法上加@ApiOperation

@Controller
@RequestMapping("/contact")
@Api(value = "联系人接口", tags = "联系人接口")
@Slf4j
public class RequestController {

    @ApiOperation(value = "list接口")
    @PostMapping("/list")
    public String test(@RequestParam LocalDate date, @RequestBody List<Long> ids) {
        log.info(date + ids.toString());
        return date + ids.toString();
    }

}

1.4 访问swagger界面

我的端口是8081,链接为 http://localhost:8081/swagger-ui.html长这样，估计是版本有点低，界面看起来和工作在用的比较起来有点差；

2、入参

1. 当我们不传列表的时候，单个参数可以放在url上，使用@ReqeustParam;
2. 当我们传递list的时候，放在请求体里面，使用@RequestBody;

2.1 传递日期报错，无法正常解析；

Failed to convert value of type 'java.lang.String' to required type 'java.time.LocalDate';

需要添加一个WebMvcConfig，注册一个String转LocalDate的转换器

package com.xky.mybatisplus.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.core.convert.converter.Converter;
import org.springframework.format.FormatterRegistry;
import org.springframework.util.StringUtils;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.time.LocalDate;
import java.time.format.DateTimeFormatter;

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        registry.addConverter(localDateConvert());
    }

    public Converter<String, LocalDate> localDateConvert() {
        // 不能替换为lambda表达式
        return new Converter<String, LocalDate>() {
            @Override
            public LocalDate convert(String source) {
                if (StringUtils.hasText(source)) {
                    return LocalDate.parse(source, DateTimeFormatter.ofPattern("yyyy-MM-dd"));
                }
                return null;
            }
        };
    }

}