）：springboot利用swagger构建api文档

–>

Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。

在springboot中使用swagger

1.添加swagger依赖

2.添加swagger配置

注意spring boot的包结构，否则会导致配置无效。示例程序的包结构：

com.ybf.activity.web|

—————————|config

———————————–Swagger2.java

———————-Application.java

3.在接口方法上使用注解添加描述信息

默认会对所有的方法生成API文档，如果某个方法不需要，可以添加@ApiIgnore。

启动SpringBoot程序，浏览器输入:项目上下文路径/swagger-ui.html就可以看到效果。

点击某个请求，可以查看详情：

输入参数，点击Try it out按钮可以查看响应。