第十一篇 SpringBoot 2 x整合Swagger2

程序猿最烦两件事，第一件事是别人要他给自己的代码写文档，第二件呢？是别人的程序没有留下文档。

程序员最讨厌的四件事：写注释、写文档、别人不写注释、别人不写文档……

关于写文档这个事情，争论已久，今天就介绍一个解决这个问题的东东，Swagger。这里介绍的是由程序员DD翟永超提供的spring-boot-starter-swagger关于其详细设置在文章底部。

pom.xml

<dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- 引入swagger2 --><dependency><groupId>com.spring4all</groupId><artifactId>swagger-spring-boot-starter</artifactId><version>1.8.0.RELEASE</version></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency></dependencies>
复制代码

在这里我们需要做的事情就不像引入官方依赖一样需要一个个的加注解，只需要一个注解就OK了。@EnableSwagger2Doc，这个注解加在启动类上

package com.priv.gabriel;import com.spring4all.swagger.EnableSwagger2Doc;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@EnableSwagger2Doc
@SpringBootApplication
public class Demoforswagger2Application {public static void main(String[] args) {SpringApplication.run(Demoforswagger2Application.class, args);}
}复制代码

输入http://localhost:8080/swagger-ui.html进行访问

打开UserController看一下继续查看一个具体的请求基本信息都有了，也可以在这里测试接口。

可以看到我们几乎没有怎么操作一个文档就建立完毕了。 spring-boot-starter-swagger项目及文档本项目的下载地址

转载于:https://juejin.im/post/5c1ca9dce51d4548ec65d57c

第十一篇 SpringBoot 2 x整合Swagger2相关推荐

springboot笔记08——整合swagger2
Swagger是什么? Swagger是一个RESTFUL 接口的文档在线自动生成和功能测试的框架.利用swagger2的注解可以快速的在项目中构建Api接口文档,并且提供了测试API的功能. Spr ...
玩转 SpringBoot 2 之整合 JWT 下篇
前言在<玩转 SpringBoot 2 之整合 JWT 上篇> 中介绍了关于 JWT 相关概念和JWT 基本使用的操作方式.本文为 SpringBoot 整合 JWT 的下篇,通过解决 ...
Swagger的安装以及SpringBoot整合Swagger2实现SwaggerAPI文档测试
前言本篇博客是本人在网上学习Swagger所产出的个人笔记.主要内容有: 1.Swagger的安装 2.Swagger的介绍 3.Swagger2中常用的注解 4.快速上手案例准备工作:Swagg ...
SpringBoot学习笔记(16)----SpringBoot整合Swagger2
Swagger 是一个规范和完整的框架,用于生成,描述,调用和可视化RESTful风格的web服务 http://swagger.io Springfox的前身是swagger-springmvc,是 ...
业务规范之springboot整合swagger2
业务规范(整合swagger2) ###业务规范之springboot整合swagger2 ###业务规范之统一验证 ###业务规范之统一返回体 ###业务规范之统一异常处理和统一响应二.整合swa ...
SpringBoot整合Swagger2
整合Swagger2 1.Swagger介绍前后端分离开发模式中,api文档是最好的沟通方式. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web ...
springboot整合 swagger2
springboot整合 swagger2 引入依赖 <dependency><groupId>io.springfox</g ...
SpringBoot整合Swagger2教程
SpringBoot整合Swagger2教程环境说明 springboot 版本 2.4.4 swagger2 版本 2.9.2 工程准备创建Springboot工程.这一步不会的可先去Hello ...
玩转 SpringBoot 2 之整合定时任务篇
前言通过本文你将了解到如何在 SpringBoot 2 中整合定时任务使用教程,具体详细内容如下: SpringBoot 自带定时任务使用教程 SpringBoot 集成 JDK 定时任务使用教程 ...

第十一篇 SpringBoot 2 x整合Swagger2

pom.xml

第十一篇 SpringBoot 2 x整合Swagger2相关推荐

最新文章

热门文章