swagger的配置（swagger3配置）



只需要加一个依赖，并且要注意，swagger3在springboot2.5版本以上会出现问题

如果高于2.5版本会报错：

解决方法是降低spring的版本到2.5.x以下，或者是降低swagger版本到3以下，或者是在SwaggerConfig注解上标注@EnableWebMvc

可以看到这个类存在CardInfo嵌套类，对嵌套类的配置同上：

注意：实体类的字段都需要有get方法，不然会失效，这里统一使用lombok的@Data解决

这里面的返回值AjaxResult需要定义好泛型，在返回值初定义类型

1. 注解：

   注解用于描述整个 API，通常放在控制器类上，一般使用tags注解就可以

2. 注解：

   注解用于描述具体的 API 操作，通常放在控制器方法上

3. 注解：

   注解用于描述方法参数，提供参数的名称、描述等信息。

4. 和 注解：

   这两个注解用于描述操作的响应信息，作用在方法上。

5. 和 注解：

   这两个注解用于描述数据模型，通常放在实体类上。其中，下述的example可以实现在swagger页面调接口的默认值，并且如果导入到如eolink这种api管理工具，这个默认值也会填充进去。

6. 注解：

   注解用于标记不想在 Swagger 文档中显示的类、方法。

   上述的 类及其所有方法将被忽略。

7. 注解：

   注解用于表示参数，需要被包含在注解之内。

点击主页这个地方

按F12，在源代码里面的v2-api-docs里面右键另存为

输入名称和后缀进行保存

点api向下的箭头，再选swagger

导入成功后可以看到，传参和返回值都能被正确识别和导入，包括传参的默认值也有

版权声明：

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符，请将相关资料发送至xkadmin@xkablog.com进行投诉反馈，一经查实，立即处理！

转载请注明出处，原文链接：https://www.xkablog.com/rfx/52102.html