swagger2和3的区别（swagger3使用）



接口文档总是很烦人，我曾经尝试过用Postman来编写和分享项目文档，感觉还不错。但是最近项目紧，我没有额外的时间可以花在它上面，这也导致我尝试YApi（另外一种文档）的计划泡汤了。嗯，目前没有比Swagger更快、更傻瓜的工具，虽然它有严重的代码污染。先拿这个对付一阵时间，等闲暇时间再玩YApi。

Swagger目前最新版本是3.0.0,在Spring Boot应用中集成Swagger3比老的Swagger2简单多了，它提供了一个Starter组件。

就这就可以了，简单不？

至于有的教程说还要开启注解，完全不需要。因为在下你可以找到一个，熟悉Spring Boot的同学都知道这个是一个Spring Boot 特有的SPI文件，能够自动的发现并注册Starter组件的配置。里面有这样的配置：

顺藤摸瓜，找到总的配置类：

我们找到了关键的一个地方注解声明了当为时启用配置，而且默认值就是。这非常有用，Swagger仅仅建议在开发阶段使用，这个正好是个开关。另外有时候我们自定义配置的时候最好把这个开关也加上：

❝

如果你想在Swagger3中加入Json Web Token，可以参考这篇文章。

最开始我们提到Swagger3不需要使用或者开启，这里也能找到答案。

上面的两个导入类都可以在找到，所以Swagger3提供的是全自动的集成。

如果你使用了统一返回体封装器来标准化Spring MVC接口的统一返回

你会发现Swagger3会报的错误，这是因为统一返回体影响到了Swagger3的一些内置接口。解决方法是控制好生效的包范围,也就是配置其参数就行了，这个潜在的冲突浪费我了一个多小时。

如果你使用安全框架，Swagger3的内置接口就会访问受限，我们需要排除掉。Spring Security是这么配置的：

如果你使用的版本是Spring Security 5.4，你可以这么定制:

更加方便简单，这样Swagger就能正常的渲染和访问了。

今天分享了一些swagger3的配置心得，希望能够帮助你上手最新的swagger3文档工具。

何时使用Java Stream,何时使用Java集合框架

微信支付V3开发包Payment Spring Boot收到了第一个PR

版权声明：

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

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