java1234的博客

大家好，我是锋哥，我是一名鼎鼎小名的10年Java老湿；最近花了半天时间，撸了个Swagger3 API文档工具视频教程，免费分享给大家，文章底部有分享链接；Swagger（丝袜哥）是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统，数以千计的开发人员，使用几乎所有的现代编程语言，都在支持和使用Swagger。使用Swagger生成API，我们可以得到交互式文档，自动生成代码的SDK以及API的发现特性等。前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同，s

我们可以通过设置Docket，可以配置很多功能，比如是否开启swagger，过滤，分组等；6.1 开关设置enable一般情况，我们只有在开发环境才会用到swagger，正式环境需要关闭swagger，一个是安全问题，还有一个是用了swagger会影响系统运行速度；我们通过设置Docket对象的enable即可；/** * 配置swagger的Docket bean * @return */@Beanpublic Docket createRestApi() { return new D

默认情况，显示的API信息如下：通过源码，我们可以看到：这个信息是通过springfox.documentation.service.ApiInfo.java类来构造的；最终通过springfox.documentation.spring.web.plugins.Docket.java类的构造方法传入ApiInfo类来最终构造；我们要修改API信息默认配置的话，可以通过新建一个com.java1234.config.Swagger3Config.java配置类，重写ApiInfo实现，以及重写D

swagger-ui图形客户端提供了接口测试功能；默认情况下，这些参数都不能填写，禁用的；我们点击“Try it out”按钮；即可开启接口测试功能；输入请求参数后，点击“Execute‘按钮，即可执行，下方是后端返回信息；类似的，我们可以测试添加功能；说明：很多时候，前后端分离，传的是json，键值对，用swagger-ui提供的简陋接口测试工具很难用，所以接口测试我们还是用专业的postman说明：这个是锋哥的Swagger3备课笔记，等备课完，会发布配套的视频教程，如有需要，可以

3.1 Swagger3常用配置如下：swagger提供了一些配置用来描述接口，下面是一些常用的注解，必须掌握；@Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value="该参数没什么意义，在UI界面上也看到，所以不需要配置"@ApiOperation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明"@ApiImplicitParams：用在请求的方法

第一步：我们新建一个SpringBoot项目；加一个Spring Web依赖加下Swagger依赖：<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-starter</artifactId> <version>3.0.0</version></dependency>这里用的是 springfox，S

Swagger（丝袜哥）是一个简单但功能强大的API表达工具。它具有地球上最大的API工具生态系统，数以千计的开发人员，使用几乎所有的现代编程语言，都在支持和使用Swagger。使用Swagger生成API，我们可以得到交互式文档，自动生成代码的SDK以及API的发现特性等。前后端分离的项目，接口文档的存在十分重要。与手动编写接口文档不同，swagger是一个自动生成接口文档的工具，在需求不断变更的环境下，手动编写文档的效率实在太低。与swagger2相比新版的swagger3配置更少，使用更加方便。官