swgger-bootsrap-ui 一个好看的api文档生成器

传送门d-swgger-bootsrap-ui

原生的swagger好丑, 看到xiaoymi 一款新的swagger 文档生成器.所以就出现了这样一个教程.大家看好了.

使用的是SpringBoot, 创建SpringBoot项目就省略了.

配置swagger

直接开始讲解代码:

25行, 就不用了吧,这是SpringBoot的配置注解, 就是说这是一个配置

26行, 开始swagger 和SpringBoot 的 @Enable...其他功能是一样的, 是开启某一项功能

第一个方法, createGitHubRestApi,  这个方法是添加一些必要的信息, 比如在header里面添加 Auth 授权码, 扫描有@Api注解的类, 生成Api文档, 还可以扫描包来生成文档.

第二个方法createRestApi  , 这个方法是指定文档的风格, 还有分组的哪些,生成的效果是

可以添加多个分组, 添加多个生成的描述, 就会存在多个, 比如可以添加学校, 公司,政府部门等等分组, 一个文档可以有多个分组哦, 就像excel可以有多个sheet一样.

第三个方法.apiInfo, 这是对文档的一些总体的描述.

添加注解

在controller上面添加注解

注意啦, 有同学在github上问我, 我想要按照字母排序怎么搞, 告诉你, 这是不行的, 不能按照字母的字典排序, 看swagger的源码就可以发现这个问题.可以在tags标签上添加排序号来处理.

添加方法注解

 

直接在方法上添加注解, 就可以了, 表明GET 还是POST 请求

请求生成文档

请求地址:127.0.0.1:8080/doc.html就可以访问到了

来看一下效果: