关于Swagger文档请求异常(Swagger注解相关原因)

关于Swagger文档请求异常(Swagger注解相关原因)

错误详情:

F12开发模式查看报错代码如下:

SyntaxError: Unexpected token . in JSON at position 33783
    at JSON.parse (<anonymous>)
    at Object.json5parse (app.23f8b31d.js:1:325473)
    at r.transformResponse (app.23f8b31d.js:1:175666)
    at chunk-vendors.90e8ba20.js:2:1982347
    at Object.l [as forEach] (chunk-vendors.90e8ba20.js:2:1984092)
    at e.exports (chunk-vendors.90e8ba20.js:2:1982322)
    at chunk-vendors.90e8ba20.js:2:1360843

异常图片如下:
异常图片

原因分析

  1. 查看报错代码,提示为JSON编译错误。
  2. 查看项目中Swagger相关注解代码,多次尝试后定位到错误,如下代码所示:
@ApiModelProperty(value = "日志内容",example = "[127.0.0.1][中国浙江杭州西湖] 验证码错误!")
private String loginInfo;

结合问题代码与错误提示,相信大家已经知道问题所在了,在Swagger注解中的example字段内容中被[ ]包裹的内容被识别为JSON格式。导致生成文档时出现问题。

总结

本次问题产生时,一直在百度,没有仔细查看错误提示。白费了一些功夫,所以特地写这个帖子,希望提醒自己出现错误时,先静下心仔细查看提示。


版权声明:本文为GQ_WELL原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。