swagger导出接口文档

最近工作上需要用Swagger导出接口文档
经过查找资料总结了一下：

Swagger简介

1、是一款让你更好的书写API文档的规范且完整框架。
2、提供描述、生产、消费和可视化RESTful Web Service。
3、是由庞大工具集合支撑的形式化规范。这个集合涵盖了从终端用户接口、底层代码库到商业API管理的方方面面。
简单来说，Swagger是一个帮助开发人员编写接口文档的工具，它可以帮你自动生成接口文档。

Swagger使用

项目中使用Swagger有两种方法
1.**

使用第三方依赖

**

(1) pom.xml文件引入依赖：

<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>1.7.0.RELEASE</version>

(2)在Spring Boot项目的启动类上添加@EnableSwagger2注解，api方法中添加注解。

2.使用官方依赖

①　pom.xml文件引入依赖:

io.springfox springfox-swagger2 2.7.0 io.springfox springfox-swagger-ui 2.7.0

②　编写Swagger控制类

注意：swagger scan base package,这是扫描注解的配置，即你的API接口位置。需要修改为实际项目的Api位置
③　在Spring Boot项目的启动类上添加@EnableSwagger2注解，api方法中添加注解。

3访问api doc 路由
项目启动后可以打开浏览器访问：
页面图下：

访问地址为：http://localhost:8080/swagger-ui.html（端口号应改为实际项目端口号）
注：生成静态文档使用的url为红色框中url，而不是swagger-ui.html
图中红色框地址是默认路由，访问路由可以进行配置：
application.yml中声明：
springfox.documentation.swagger.v2.path: /api-docs
/api-docs就是自定义的路由，可以自定义
生成的接口文档可以在线进行接口测试
*需要注意的是当前日志文档是动态的，项目启动才可以以网页方式访问
4

Swagger常用Api

1、api标记
Api 用在类上，说明该类的作用。可以标记一个Controller类做为swagger 文档资源，使用方式：

@Api(value = “/user”, description = “Operations about user”)

2、ApiOperation标记
ApiOperation：用在方法上，说明方法的作用，每一个url资源的定义,使用方式：

@ApiOperation(
value = “Find purchase order by ID”,
notes