第十一篇:SpringBoot 2.x整合Swagger2

  1. 云栖社区>
  2. 博客>
  3. 正文

第十一篇:SpringBoot 2.x整合Swagger2

gabriel丶 2018-10-23 16:01:00 浏览829
展开阅读全文

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

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

关于写文档这个事情,争论已久,今天就介绍一个解决这个问题的东东,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进行访问

img_abd563e889183ac43092426196ea375c.png
image.png

打开UserController看一下
img_6a6a0065cd12f2c5780ec64ab4b7b3e8.png
image.png

继续查看一个具体的请求
img_1e8aeb5c911bcccc366365fe9424b2ca.png
image.png

基本信息都有了,也可以在这里测试接口。

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

网友评论

登录后评论
0/500
评论
gabriel丶
+ 关注