swagger使用过程中遇到的坑

1、无限请求

如果swagger页面请求有错误,swagger会无限尝试访问,后面重启项目的时候,控制层会无限刷新出现日志的内容

本地的好办,如果项目项目部署到服务器中,可能十几分钟产生几个G的日志文件

解决方式:最简单的方式——关闭请求报错的浏览器

 

2、同名问题

@Api(同名的问题) 因为swagger会根据tags 的名称查找对象,有同名对象的时候,swagger的文档就会出现问题
如果swagger的某个API下出现不属于该API的请求,这个就是API的同名的问题,查找相同的API名称替换即可

 

3、类上的注解“/”的问题

@ApiModel(不能使用“/”)

1

2

3

4

Errors

Hide

Resolver error at paths./v1-0/Configuration/add.post.parameters.1.schema.properties.listHotCarBrandIVO.items.$ref

Could not resolve reference because of: Could not resolve pointer: /definitions/热门车/品牌/的IVO does not exist in document

 

4、使用map作为返回类型报错,

1

2

3

4

Errors

Hide

Resolver error at definitions.Map«string,List«卖车车辆信息OVO»».additionalProperties.$ref

Could not resolve reference because of: Could not resolve pointer: /definitions/List does not exist in document

  两个解决方案:升级swagger版本号,这个是我用2.8.0报错会报错,网上有说升级版本可以解决,这个我没有去试,

1

2

3

4

5

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.8.0</version>

</dependency>

 我这边的解决方案是,将map定义在对象中,面向对象编程,而且这样生成文档的时候,注释也会显示好

 

5、swagger版本的问题,2.8之前的版本在  路径/{id} +@pathVarisble  这样的写法

  2.8之前,swagger给出的类型居然是body,需要用json的格式传这个很奇怪,

  版本更新到2.8以后,路径后面绑定的参数就是 swagger给出的类型居然是就能是param

  适当的更新版本有好处

1

2

3

4

5

6

7

8

9

10

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger2</artifactId>

    <version>2.8.0</version>

</dependency>

<dependency>

    <groupId>io.springfox</groupId>

    <artifactId>springfox-swagger-ui</artifactId>

    <version>2.8.0</version>

</dependency>

  

 6没有重现过的一个bug

1

Failed to execute 'fetch' on 'Window': Failed to parse URL from http://localhost/8765undefindFailed to parse URL from http://localhost/8765undefind

  我一直重启项目 swagger没有重现问题

  后来我修改请求你方法上的api注释,重启就可以,可能是swagger上api冲突,关键是这个没有提示,好晕;如果谁找到重现这个问题来说一下

要在Spring项目使用Swagger,需要进行以下几个步骤: 1.添加Swagger依赖 在项目的pom.xml文件添加以下依赖: ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.9.2</version> </dependency> ``` 2.配置Swagger 在Spring Boot项目,可以创建一个Swagger配置,以配置Swagger。在这个,需要使用`@EnableSwagger2`注解来启用Swagger,并使用`@Bean`注解来创建一个Docket对象。 ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.basePackage("com.example.controllers")) .paths(PathSelectors.any()) .build(); } } ``` 在上面的示例,我们创建了一个名为`api`的Docket对象,它表示我们要为API生成Swagger文档。我们使用`RequestHandlerSelectors`和`PathSelectors`来定义哪些控制器和请求路径应该被包含在Swagger文档。 3.访问Swagger UI Swagger UI是一个可视化的API文档界面,可以使用它来查看生成的Swagger文档。在Spring Boot应用程序,可以通过访问`/swagger-ui.html`路径来访问Swagger UI。 例如,如果应用程序运行在本地的端口8080上,则可以在浏览器访问`http://localhost:8080/swagger-ui.html`,以查看生成的Swagger文档。 希望这些步骤可以帮助您在Spring项目使用Swagger
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值