前阵子偶然接触到一个小框架，立马被深深吸引，然后研究一阵子后，今天有时间了，可以在这里给总结一下，算是一个小结，也是自己学习的一个记录。

记得一年前，初次接触API开发文档时，那时候是一遍写代码，一边写文档或者是代码写完后，然后再回过头来写开发文档，相信不少人都有这样的经验。

前阵子接触到swagger-ui,马上被它的便捷性锁吸引，下图是工作中代码生成的API，涉及到公司业务的，已打码。

下面，创建一个小Demo，使用SpringBoot整合一下swagger-ui这个框架，算是对自己学习的一个补充，也算是一份基础入门教程，希望可以帮助到有需要的朋友~目前感觉这个框架在国内还不是特别火的样子~

第一步：创建一个SpringBoot项目，然后加入相关依赖，下面是我的pom.xml文件：

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

4.0.0

cn.jiayao

demo

0.0.1-SNAPSHOT

war

demo

Demo project for Spring Boot

org.springframework.boot

spring-boot-starter-parent

1.5.10.RELEASE

UTF-8

UTF-8

1.8

ali

http://maven.aliyun.com/nexus/content/groups/public/

org.springframework.boot

spring-boot-starter-web

org.springframework.boot

spring-boot-starter-test

test

com.spring4all

spring-boot-starter-swagger

1.5.1.RELEASE

org.projectlombok

lombok

org.springframework.boot

spring-boot-devtools

org.springframework.boot

spring-boot-maven-plugin

上面我引入了3个依赖，分别是swagger-ui的、lombok的，还有热部署的。

第二步：在main方法类上添加注解

@EnableAsync

@EnableSwagger2Doc

@SpringBootApplication

图片上框起来的两个注解是需要自己添加的，至于为什么要添加，这个你不添加试一下就知道了。

不要问我为什么知道，这个坑，我算是趟过去了~

就是这个样子，报错，还找不到原因。。。。。。。。。。。

第三步：设置配置文件

1：设置端口号

2：设置访问路径

3：设置数据库信息(/看需求)

4：设置swagger-ui相关信息

配置文件默认为：application.properties格式，推荐使用yaml格式

IDEA需要安装yaml插件，eclispe具体不是很清楚

第四步：创建controller类

我的直接贴图

第五步：运行程序，让程序跑起来，然后访问

我的端口号设置的是8080

访问地址：127.0.0.1:8080/swagger-ui.html

注解对应有相应的含义

文字更多的是用图片来描述的，因为我刚开始学习的时候，踩过太多的坑了。

在网上搜了很多相关资料，看的都不是很懂，有些描述，知道的人一眼就明白，对于刚接触的人来说，可能得看一会才能看得懂。

所以多贴点图片，帮助别人，也帮助自己^_^

谁让我这么菜...

关于application.yml

里面配置了mysql地址，但是整合mysql，还需要在pom文件中添加mysql的依赖哦~

中午遇到一个坑，耽误了一个多小时。等会另外写出来。今天也是处于使用springBoot整合swagger-ui，踩了坑。明天公司才放假...

提前预祝新年快乐啦~~~

2018-02-13 14:11:04