OpenApi3/Swagger3简单使用及与swagger2对比

最新推荐文章于 2024-05-24 11:29:30 发布

long-king

最新推荐文章于 2024-05-24 11:29:30 发布

阅读量1w

点赞数 5

分类专栏：公共文章标签： Swagger OpenApi3 Swagger3

本文链接：https://blog.csdn.net/long199366/article/details/114388171

版权

本文介绍了Swagger2因停止维护而被Swagger3（OpenApi3）取代的情况，详细讲解了OpenApi3的特性和SpringDoc的使用。对比了Swagger3和Swagger2的注解差异，并提供了从Spring-Fox迁移到SpringDoc的步骤，强调了Swagger3在Spring Boot中的应用和优势。

摘要由CSDN通过智能技术生成

Swagger 3 的使用

Swagger2已经在17年停止维护了，取而代之的是 Swagger3（基于openApi3），这篇文章将介绍如何在 java 中使用 OpenApi3（swagger3）以及与swagger2的对比。

1.基本介绍

1.1 Open API

OpenApi是业界真正的 api 文档标准，其是由 Swagger 来维护的，并被linux列为api标准，从而成为行业标准。

1.2 Swagger

swagger 是一个 api 文档维护组织，后来成为了 Open API 标准的主要定义者，现在最新的版本为17年发布的 Swagger3（Open Api3）。国内绝大部分人还在用过时的swagger2（17年停止维护并更名为swagger3）。swagger2的包名为 io.swagger，而swagger3的包名为 io.swagger.core.v3。

1.3 SpringFox

SpringFox是 spring 社区维护的一个项目（非官方），帮助使用者将 swagger2 集成到 Spring 中。常常用于 Spring 中帮助开发者生成文档，并可以轻松的在spring boot中使用。截至2020年4月，都未支持 OpenAPI3 标准。

补充：2020.7.14 发布了 3.0 支持 OpenAPI3，github 发布记录但官网对 3.0 版本相关文档未完善，还是只有 swagger 2.0 相关的。
升级到 OpenAPI3（java 中 swagger1.x 对应 OpenAPI2、swagger 2.x对应OpenAPI3）官方文档