介绍:
1、Swagger2是什么?
Swagger 是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。官网:http://swagger.io/GitHub地址:https://github.com/swagger-api/swagger-ui
2、Swagger2官网
3.Swagger2的入门教程
在微服务架构流行的今天,RESTful API成了服务间交互的主要方式之一,Swagger则成为服务之间的契约描述、提高调试、测试效率的重要工具。 Swagger工具包括Swagger Editor、Swagger UI、Swagger Codegen:
- Swagger Editor——支持编辑Swagger API规范yaml文档描述API,并可实时预览API。
- SwaggerUI——API在线文档生成和测试的工具,可显示API描述,并且支持调用API进行测试及验证。
- Swagger Codegen——一个模板驱动引擎,通过分析用户Swagger资源声明以各种语言生成客户端SDK或Server端桩代码,从而让开发团队能够更好的关注API的实现和调用,提高开发效率.
3.1Swagger2的maven依赖
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>
3.2SwaggerConfig的配置
/**
* Created by Zhaky on 2017/3/17.
* @项目名称:XXXXX
* @类名:SwaggerConfig
* @类的描述: Restapi SwaggerConfig的基本配置
* @作者:Zhaky
* @创建时间:2017/3/17