解决springboot引入swagger2不生效问题

 更新时间:2022年05月17日 08:53:52   作者:爱好jyh  
这篇文章主要为大家介绍了解决springboot引入swagger2不生效问题的方案,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

今天遇到跟同事遇到一个由于失误导致的问题,也可以说比较难发现了.在此记录一下(我们用的springboot是2.0.3,swagger是2.2.2)

问题描述:

swagger修改title,description等都不生效。并且启动springboot,没有有去加载swagger的配置类。(在debug模式启动)

经过不断的查找,发现了原因是:swagger的配置类的注解加错了。@Configuration不小心写成了@Configurable.

还有就是@EnableSwagger2注解只需要加在swagger配置类上

springboot引入swagger2的步骤:

①引入依赖

<!--  引入swagger包 -->
        <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>

②编写Swagger2的配置类

@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket api(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(getApiInfo())
                .select()
               .apis(RequestHandlerSelectors.basePackage("com.xx.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo getApiInfo(){
        return new ApiInfoBuilder()
                .title("Swagger2....")
                .description("Swagger2")
                .version("1.0")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .build();
    }
}

③在controller中添加注解:按需添加注解

@Controller
@RequestMapping("/user")
@Api(tags = "我的接口模块")
public class UserController {
    @Autowired
    private UserService userService;
	//注意这个注解跟请求对应的@XxxMapping,要不然这个接口会生成好多方法
    @GetMapping(value = "/getUserById")
    @ResponseBody
    @ApiOperation(value = "根据ID查询User")
    public User getUserById(@RequestParam(value = "id") int id){
        return userService.getUserById(id);
    }
}

④在model(pojo)上加注解,按需添加

@ApiModel(value = "用户对象")
public class User {
    @ApiModelProperty(value = "用户ID", name = "userId")
    private Integer userId;
    @ApiModelProperty(value = "用户姓名",name = "userName")
    private String userName;
    @ApiModelProperty(value = "用户密码",name = "password")
    private String password;
    @ApiModelProperty(value = "用户手机号",name = "phone")
    private String phone;

一些注解的使用

@Api:一般用于Controller中,用于接口分组

@ApiOperation:接口说明,用于api方法上。

@ApiImplicitParams:用在方法上包含一组参数说明

@ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面

paramType:参数放在哪个地方

header 请求参数的获取:@RequestHeader

query 请求参数的获取:@RequestParam

path(用于restful接口) 请求参数的获取:@PathVariable

body(不常用)

form(不常用)

name:参数名

dataType:参数类型

required:参数是否必须传

value:参数的意思

defaultValue:参数的默认值

@ApiResponses:用于表示一组响应

@ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息

code:数字,例如400

message:信息&#xff0c;例如”请求参数没填好”

response:抛出异常的类

@ApiModel:描述一个Model的信息(这种一般用在post创建的时候,使用@RequestBody这样的场景,请求参数无法使用@ApiImplicitParam注解进行描述的时候)表明这是一个被swagger框架管理的model,用于class上

@ApiModelProperty :使用在实体类上的成员变量上,描述成员变量的含义。

以上就是解决springboot引入swagger2不生效问题的详细内容,更多关于springboot引入swagger2的资料请关注脚本之家其它相关文章!

相关文章

  • java控制台实现拼图游戏

    java控制台实现拼图游戏

    这篇文章主要为大家详细介绍了java控制台实现拼图游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-07-07
  • MyBatis 实现批量插入和删除中双层循环的写法案例

    MyBatis 实现批量插入和删除中双层循环的写法案例

    这篇文章主要介绍了MyBatis 实现批量插入和删除中双层循环的写法案例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-01-01
  • 一篇文章搞定数据库连接池

    一篇文章搞定数据库连接池

    数据库连接池在编写应用服务是经常需要用到的模块,太过频繁的连接数据库对服务性能来讲是一个瓶颈,使用缓冲池技术可以来消除这个瓶颈,本文就来介绍Java常见的几种,感兴趣的可以了解一下
    2021-07-07
  • java实现简易五子棋游戏

    java实现简易五子棋游戏

    这篇文章主要为大家详细介绍了java实现简易五子棋游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-06-06
  • java开发之闹钟的实现代码

    java开发之闹钟的实现代码

    本篇文章介绍了,在java中闹钟的实现代码。需要的朋友参考下
    2013-05-05
  • Java编译错误问题:需要class,interface或enum

    Java编译错误问题:需要class,interface或enum

    这篇文章主要介绍了Java编译错误问题:需要class,interface或enum,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-02-02
  • Spring Bean的属性注入方式

    Spring Bean的属性注入方式

    这篇文章主要介绍了Spring Bean的属性注入方式的相关资料,需要的朋友可以参考下
    2018-02-02
  • IDEA 集成log4j将SQL语句打印在控制台上的实现操作

    IDEA 集成log4j将SQL语句打印在控制台上的实现操作

    这篇文章主要介绍了IDEA 集成log4j将SQL语句打印在控制台上的实现操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-02-02
  • SpringBoot使用spring retry重试机制的操作详解

    SpringBoot使用spring retry重试机制的操作详解

    实际工作中由于网络波动等原因导致代码执行失败需要重新执行,保证最终能够完成业务功能,通常来说,会用try/catch,while循环或者定时任务重处理,但是这样的做法缺乏统一性,要多写很多代码,spring-retry组件可以通过注解优雅的实现重处理功能
    2024-12-12
  • Java深入理解代码块的使用细节

    Java深入理解代码块的使用细节

    所谓代码块是指用"{}"括起来的一段代码,根据其位置和声明的不同,可以分为普通代码块、构造块、静态块、和同步代码块。如果在代码块前加上 synchronized关键字,则此代码块就成为同步代码块
    2022-05-05

最新评论