博客
关于我
报错:Required String paramenter "开始时间"
阅读量:618 次
发布时间:2019-03-13

本文共 1699 字,大约阅读时间需要 5 分钟。

《 Swagger参数注入优化笔记》

最近在尝试使用 Swagger 2.x 的时候遇到了一个关于参数注入的问题,导致程序报错,感觉有点难下手。今天想一下怎么解决这个问题,记录下来方便以后查阅。

问题描述:

当在某个 controller 方法头注入 String 参数 "开始时间" 的时候,系统报错提示 Required String parameter "开始时间",提示无法找到正确的注入参数。虽然看起来和 Swagger 参数映射相关,但仔细检查发现问题其实在参数名称的命名不统一。

开发环境配置:

spring-bootVersion=2.1.4Lucene version: 8.11.6δίwa{xIJlqXStY"(把实际应用的版本和依赖库打印出来更清晰/Application.Controllers*Controller.java)// 其他配置...

####问题原因:Spring Boot 无法识别正确的注入源,原因在于:

  • @ApiParam@RequestParam 的命名不统一。

    • @ApiParam默认映射的是يبądutyProfile 参数 namespacing。

    • @RequestParam直接解析请求参数名。

    • 比如,如果 controller 中使用 @ApiParam(name = "startTime")@RequestParam(value = "开始时间"),但 Spring 只能识别其一,导致参数无法正确注入。

####解决方法:

  • 参数命名统一:确保controller 方法中的 @ApiParam@RequestParam 的 name 填写一致。

    比如,无论是使用 startTime 还是 开始时间,方法内部参数命名都应选择一个(如 startTime)。

  • 使用默认映射:如果需要灵活映射,可以在 controller 方法中使用 @RequestBody@RequestParam:

    @PostMapping("/api/test")public ResponseEntity test(    @ApiParam("startTime") String startTime,    @RequestBody Map
    requestBody) { // 处理逻辑}
  • 注意 Swagger文档优化:

    • 确保 API 端点在 Swagger 文档中正确显示:
      paths:  /api/test:    post:      description: 测试端点      requestBody:        required: true        content:          application/json:            schema:              $ref: '#/components/schemas/Request'
    • 检查 Swagger UI 是否正确显示参数和请求体。
  • ####实际修复示例:假设修改后的 controller 方法头为:

    @ApiParam(name = "startTime")String startTime,@RequestParam(name = "开始时间")String requestBody,

    结果验证:

    • Swagger UI 中可以看到正确映射的参数名称。
    • 调用测试 API 后,能在 console 中看到 startTimerequestBody 正确传输.
    • 无报错提示,程序正常运行.

    总结:

    参数命名不规范会导致Spring Boot 异常处理机制出现问题,建议开发者在 Swagger 2.x 开发过程中统一参数命名,避免混淆。在遇到实际问题时,及时通过IDE反馈调试,确保 controller 中的 @ApiParam@RequestParam 的名称配合正确。这样不仅节省调试时间,也有助于 API 文档的规范化。

    原文:2019-07-15 Mr.chenyb

    转载地址:http://jiyaz.baihongyu.com/

    你可能感兴趣的文章
    Mysql中各类锁的机制图文详细解析(全)
    查看>>
    MySQL中地理位置数据扩展geometry的使用心得
    查看>>
    Mysql中存储引擎简介、修改、查询、选择
    查看>>
    Mysql中存储过程、存储函数、自定义函数、变量、流程控制语句、光标/游标、定义条件和处理程序的使用示例
    查看>>
    mysql中实现rownum,对结果进行排序
    查看>>
    mysql中对于数据库的基本操作
    查看>>
    Mysql中常用函数的使用示例
    查看>>
    MySql中怎样使用case-when实现判断查询结果返回
    查看>>
    Mysql中怎样使用update更新某列的数据减去指定值
    查看>>
    Mysql中怎样设置指定ip远程访问连接
    查看>>
    mysql中数据表的基本操作很难嘛,由这个实验来带你从头走一遍
    查看>>
    Mysql中文乱码问题完美解决方案
    查看>>
    mysql中的 +号 和 CONCAT(str1,str2,...)
    查看>>
    Mysql中的 IFNULL 函数的详解
    查看>>
    mysql中的collate关键字是什么意思?
    查看>>
    MySql中的concat()相关函数
    查看>>
    mysql中的concat函数,concat_ws函数,concat_group函数之间的区别
    查看>>
    MySQL中的count函数
    查看>>
    MySQL中的DB、DBMS、SQL
    查看>>
    MySQL中的DECIMAL类型:MYSQL_TYPE_DECIMAL与MYSQL_TYPE_NEWDECIMAL详解
    查看>>