SpringBoot集成Swagger2实现Restful(类型转换错误解决办法)

最新推荐文章于 2025-02-15 20:42:56 发布

hpym365

最新推荐文章于 2025-02-15 20:42:56 发布

阅读量2.7k

点赞数

分类专栏： SpringBoot 文章标签： swagger2 springboot java

本文链接：https://blog.youkuaiyun.com/hpym365/article/details/56675686

版权

SpringBoot 专栏收录该内容

2 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中集成Swagger2，通过添加依赖和配置类实现RESTful API的文档化。特别指出，若在Controller中未指定paramType为"path"，会导致从String到Long的类型转换错误。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

pom.xml增加依赖包

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

编写swapper2配置类

package com.springboot.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
//该注解实现让spring知道这个是配置的类
@EnableSwagger2
//注解来启用Swagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.springboot.ctrl"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("description")
                .termsOfServiceUrl("termsOfServiceUrl")
                .contact("hp")
                .version("1.0")
                .build();
    }

}

Controller内使用

@ApiOperation(value = "更新用户详细信息", notes = "更新用户详细信息notes")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "ID", paramType = "path", required = true, dataType = "Long"),
            @ApiImplicitParam(name = "user", value = "user", required = true, dataType = "User") })
    @RequestMapping(value = "/{id}", method = RequestMethod.PUT)
    public String putUser(@PathVariable Long id, @RequestBody User user) {
        User u = users.get(id);
        u.setName(user.getName());
        u.setAge(user.getAge());
        users.put(id, u);
        return "success";
    }