Swagger笔记之Swagger2配置

发布网友发布时间：2024-10-07 21:58

共1个回答

热心网友时间：2024-11-22 06:52

Swagger2配置概述

Swagger是一个围绕OpenAPI规范构建的开源工具套装，旨在设计、构建、记录和使用RESTful APIs。核心工具包括Swagger Editor - 一个基于浏览器的编辑器，用于编写OpenAPI规范，以及Swagger UI，它将规范转化为易于交互的API文档。

然而，值得注意的是，Swagger2在2017年已停止维护，如今更推荐使用其后续版本Swagger3，也就是OpenApi3。在选择依赖时，建议不要直接采用最新版本，而是从mvnrepository（Maven*仓库）中找到适合的稳定版本。

自定义配置

为了满足个性化需求，你可以创建一个名为SwaggerProperties.class的类，进行属性的自定义配置。通过这个类，你可以灵活设定Swagger的行为和外观。

集成和配置

要启用Swagger2的配置，你只需在@Configuration类上添加@EnableSwagger2注解，并确保启动类无需额外的注解。这样，Swagger的资源访问路径就会自动配置好。

在实际应用中，有一个小技巧：为了方便访问和管理API，不建议直接在Swagger的原生页面设置权限，而是推荐在文档页面设置token，这样搜索和使用接口会更加便捷。