在这里，以 Spring Boot 项目为例，给出两种自定义 Swagger2 请求 URL 路径的方法。
🏆本文收录于 《 Spring Boot从入门到精通》 ， 专门攻坚指数提升，2023 年国内最系统+最强（更新中）。
4.访问 127.0.0.1:8081/swagger-ui/index.html
现在都奉行前后端分离开发和微服务大行其道，前后端技术在各自道路上越走越远。 前后端唯一联系变成了API接口，API文档变成了前后端开发人员&测试人员联系的纽带。所以一款强大的Restful API文档就变得至关重要了。而目前在后端领域，基本上是Swagger的天下了。
Swagger官方Starter解决了之前整合Swagger的一系列问题，简化了SpringBoot整合Swagger的过程，使用起来更加方便了。同时对于一些复杂的配置使用基本没有变化，一些之前的使用方式依然可以使用！
Swagger号称是史上最流行的、最好用的API接口文档构建工具，它支持多种语言包括Java在内，本文仅关注如何使用Spring Boot来集成Swagger，更多关于Swagger的介绍可以查看以下几个链接。
最近 SpringFox 3.0.0 发布了，距离上一次大版本2.9.2足足有2年多时间了。可能看到这个名字，很多读者会有点陌生。但是，只要给大家看一下这两个依赖，你就知道了！
Swagger 是最流行的 API 开发工具，它遵循 OpenAPI Specification（OpenAPI 规范，也简称 OAS）。 Swagger 可以贯穿于整个 API 生态，如 API 的设计、编写 API 文档、测试和部署。 Swagger 是一种通用的，和编程语言无关的 API 描述规范。
在`pom.xml`文件中加入Swagger相关的依赖。对于Swagger 2.x版本，通常会使用Springfox，它是Swagger的一个Java实现，可以帮助我们在Spring Boot应用中集成Swagger。在Maven项目中添加如下依赖：
顾翔老师开发的bugreport2script开源了，希望大家多提建议。文件在https://github.com/xianggu625/bug2testscript，
原因是在springboot2.6.0中将SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser，导致出错。（java项目fhadmin.cn）
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。
├── controller — 控制层（将请求通过 url 匹配，分配到不同的接收器/方法进行处理，然后返回结果）
Springboot2.6以后将SpringMVC 默认路径匹配策略从AntPathMatcher 更改为PathPatternParser，所以不加该配置会报错：org.springframework.context.ApplicationContextException: Failed to start bean 'documentationPluginsBootstrapper'; nested exception is java.lang.NullPointerException
4. 访问 127.0.0.1:8081/swagger-ui/index.html
上一篇《简单搭建SpringBoot项目》讲了简单的搭建SpringBoot 项目，而 SpringBoot 和 Swagger-ui 搭配在持续交付的前后端开发中意义重大，Swagger 规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务，对调用方而言非常直观，接口也可以点击try it out!按钮 进行调试，在实际开发中大大增加了开发效率。点击可了解更多 swagger 相关信息swagger-ui官网
自此一个非常方便又简单的swagger-ui集成好了，写完业务逻辑代码可以立马公布restful api给前端调用。
现在后台基本都用到了swagger，无论开发人员调试测试，还是前端用，都很方便，前段时间如果用SpringWebflux的话，只能用3.0快照版，不过最近已经发布了正式版，时隔2年多，新版本还是有很大的变化。
本篇博客是我github上our-task：一个完整的清单管理系统的配套教程文档，这是SpringBoot+Vue开发的前后端分离清单管理工具，仿滴答清单。目前已部署在阿里云ECS上，可进行在线预览，随意使用（附详细教程），大家感兴趣的话，欢迎给个star!
一般在使用 Spring Boot 开发前后端分离项目的时候，都会用到 Swagger。Swagger 是一个规范和完整的框架，用于生成、描述、调试和可视化 RESTful 风格的 Web API 服务框架。
Swagger 3.0 发布已经有一段时间了，它于 2020.7 月 发布，但目前市面上使用的主流版本还是 Swagger 2.X 版本和少量的 1.X 版本，然而作为一名合格的程序员怎么能不折腾新技术呢？所以本期就大家带来一篇最新版 Swagger 的内容，本文会带大家看最新版 Swagger 有哪些改变？又是如何将老版本 Swagger 升级到新版的？
在微服务构建的过程中，你也许发现写的那些restful风格的接口需要编写文档。 文档一般包括要输入哪些参数，哪些参数是必填的，哪些是选填的。还有返回结果的格式以及结果示例。 也许你可以通过在git上写markdown文档来做这些事情。 但每个接口对应的文档地址这些对应关系你又需要关心。 通过swagger，这一切你都不需要做了。 在你编写自己的restful接口的时候，只需要添加一些annotation就可为你自动的生成接口文档。你上面的那些内容都为你自动生成。 甚至连简单的功能测试表单都为你做好了。 总
接口文档对于前后端开发人员都十分重要。 尤其近几年流行前后端分离后接口文档又变成重中之重。 接口文档固然重要，但是由于项目周期等原因后端人员经常出现无法及时更新， 导致前端人员抱怨接口文档和实际情况不一致。 很多人员会抱怨别人写的接口文档不规范，不及时更新。 当时自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心。 如果接口文档可以实时动态生成就不会出现上面问题。 Swagger 可以完美的解决上面的问题。
1.添加依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version> </dependency> 2.自定义SwaggerConfig配置 public class Swagger3Config{ @Bean public Docket createRestA
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
一、简介 Swagger的目标是为REST API定义一个与语言无关的标准接口，允许用户发现和理解计算机服务的功能，而无需访问源代码。当通过Swagger正确定义时，用户可以用最少量的实现逻辑理解远程服务并与之交互。类似于低级编程所做的接口。 二、实现步骤 1、添加 Maven 依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.
Swagger是一组围绕 OpenAPI 规范构建的开源工具，可帮助您设计、构建、记录和使用 REST API。主要的 Swagger 工具包括：Swagger Editor – 基于浏览器的编辑器，您可以在其中编写 OpenAPI 规范。Swagger UI – 将 OpenAPI 规范呈现为交互式 API 文档。Swagger2于17年停止维护，现在最新的版本为 Swagger3（Open Api3）。
swagger作为一款不错的api查看工具在spring框架项目上使用十分广泛，使用界面如下图所示：
swagger，俗称丝袜哥，是用来生成接口文档的。没有使用swagger的时候，你写完后端接口，得自己将后端接口地址一个个地整理出来，告诉别人这个接口是干嘛的，要传哪些参数，正常情况下返回的参数是咋样的，非正常情况返回的又是咋样的。很麻烦有木有？有了丝袜哥，你只需要简单地加上几个注解，然后会有一个丝袜哥的ui界面，里面就包含了接口的所有信息，灰常地方便。
接口地址：http://localhost:8080/swagger-ui.html
在后端项目中，难免遇到需要写接口文档方便第三方调用的场景，一般业界最常用的方案是使用swagger。Java项目中，一般采用springfox项目，它集成了swagger和swagger-ui，不需要单独部署项目，可让文档随着项目一起发布。
Automated JSON API documentation for API’s built with Spring
SpringBoot引入Swagger的maven库之前，需要先引入springboot-web的maven，否则没有效果。
前端和后端的联调离不开API文档，而手动编写API文档是一项耗时又费力的操作。Swagger正是基于简化API文档的输出的一个优秀的开源框架，通过OpenAPI的规范呈现接口信息，方便的提供测试和联调。这样，如果按照新的开发模式，在开发新版本或者迭代版本的时候，只需要更新Swagger描述文件，就可以自动生成接口文档和客户端服务端代码，做到调用端代码、服务端代码以及接口文档的一致性。
对于 Rest API 来说很重要的一部分内容就是文档，Swagger 为我们提供了一套通过代码和注解自动生成文档的方法，这一点对于保证 API 文档的及时性将有很大的帮助。
@Api()用于类； 表示标识这个类是swagger的资源 - @ApiOperation()用于方法； 表示一个http请求的操作 - @ApiParam()用于方法，参数，字段说明； 表示对参数的添加元数据（说明或是否必填等） - @ApiModel()用于类 表示对类进行说明，用于参数用实体类接收 - @ApiModelProperty()用于方法，字段 表示对model属性的说明或者数据操作更改 - @ApiIgnore()用于类，方法，方法参数 表示这个方法或者类被忽略 - @ApiImplicitParam() 用于方法 表示单独的请求参数 - @ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam
浏览器访问 http://ip:port/swagger-ui/index.html
在参考了大部分博客中，发现关于Swagger-ui的文档很多，但是要迅速的完成一个Demo还是需要调试，查找文档，所有记录下了这篇文章. 导入依赖 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.2.2</version> </dependency> <d
Swagger:The Best APIs are Built with Swagger Tools 。Swagger可以定义一个标准的RESTful风格的API，与语言无关，是一个API的规范。
3、SpringApplication.run(xxx.class, args)。
前后端分开开发中，前端人员需要异步调用后端发布的RESTful API服务，后端服务繁 多，清晰同步的API文档对于前端开发人员非常重要。Swagger是一款RESTful接口的文 档在线自动生成+功能测试功能软件。Spring可以非常方便的和Swagger集成，实现API 文档的自动生成和发布。
技术栈：springboot、swagger2 gitee源码地址：https://gitee.com/shawsongyue/sevenhee_modules/tree/master/springboot_swagger
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。 作用：
最近安装并使用了一下Swagger-ui、Swagger-editor和Swagger-codegen，感觉还不错。
springfox 已经停止更新很久了，SpringBoot新版本都不支持。为了能够继续使用Swagger，只能调整继承库。
SpringDoc是一款可以结合SpringBoot使用的API文档生成工具，基于OpenAPI 3，目前在Github上已有1.7K+Star，更新发版还是挺勤快的，是一款更好用的Swagger库！值得一提的是SpringDoc不仅支持Spring WebMvc项目，还可以支持Spring WebFlux项目，甚至Spring Rest和Spring Native项目，总之非常强大，下面是一张SpringDoc的架构图。
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频
