Spring Boot系列之四 自动生成RESTful文档

简介

标题不让写那么长,嗨嗨,原文主题应该为 Spring Boot系列之四 使用Swagger2构建RESTful API文档

不知道会不会影响阅读量... 推荐越来越少了...

本来系列4和系列5的文章不打算发了的,一方面是应用机会很少,另一方面也是自己当时用的时候对Spring Boot的了解还不够透彻,有点小错误.不过有粉丝评论说直接从3到了6,中间少了两篇,不成系列了,哈哈哈.那我就把错误改改,再发出来吧.感谢粉丝~~.

正文:

可能大家受够了拿个Word写API文档了,现在Swagger2可以让大家节省很多劳动力,而且展示出来的文档,风格统一,功能强大.

但是!但是!!Swagger2毕竟是得等代码写好了,最起码也得等各个接口创建好了把相应的注解整理完整后文档才会生成.所以… 有些时候,你并不能逃避Word.

当然,当然.反过来讲,对于没有文档的老代码,我们只需要增加相应的Swagger2注解就能生成一份很好看的文档咯.

废话不多说.

实例

• 在pom.xml文件中引入

• 创建package

在`src/main/java`目录下创建一个package`swagger2`

• 创建Swagger2配置类

basePackage说明

swagger2会把父级目录下的所有子目录中包含`basePackage`的目录全部扫描,也就是说,针对某一个项目创建的文档会不小心引入其他项目的接口....

老老实实的再创建一层package吧!或者?在某个模块里边单独创建一个swagger2的配置类.

• SampleController

• 效果展示

打开浏览器输入`http://localhost:8080/swagger-ui.html`:

可以看到,swagger2展示的文档,不仅仅只有接口地址,参数列表,Http请求状态码,还包含一个RESTful接口测试的工具.我们可以直接点击`Try it out!`得到请求结果.

总结

本文只是简单的介绍了一下Swagger2在Spring Boot中的应用.如果还想继续了解Swagger2的内容,可以直接去 Swagger官网:http://swagger.io/

代码

本文限于篇幅原因,不能展示所有的代码,如果想要完整的代码示例,请移步 https://github.com/sunshineasbefore/veryjava.spring.boot/tree/master/swagger

支持请点赞,不喜勿喷.

每天一点点,成长多一点.