Swagger介绍及使用

Swagger介绍及使用

背景

随着软件技术的不断发展，一体化的软件开发方式已经逐渐被淘汰。所以前后端分离的开发方式就显得尤为重要。但是，前后端分离的话又会出现新的问题：比如：前端会经常抱怨后端给的API接口与实际不符，而后端则会因为编写和维护接口比较耗费精力，来不及更新。所以不管是前端开发者还是后端开发者，一个高效且及时的接口文档都是非常重要的。但是，编写接口文档就像写注释一样，一方面：我们会嫌弃别人写的注释不够简洁明了；另一方面：我们写代码的时候，又懒得去写注释。单单是靠这种强制规范，是远远不能达到双方都满意的效果，而且随着版本迭代，接口文档更新更是让人烦上加烦。这时Swagger就应运而生，帮助程序员编写接口文档。

Swagger是什么？能干什么？

Swagger官网第一句话就是“API Document & Design Tools Teams”接口设计工具，见名知意：就是帮助我们设计接口文档的嘛！

而且，作为Java届服务端的大一统框架Spring，也迅速将Swagger规范纳入自身的标准，建立了Spring-swagger项目，后面改成了现在的Springfox。通过在项目中引入Springfox，可以扫描相关的代码，生成该描述文件，进而生成与代码一致的接口文档和客户端代码。这种通过代码生成接口文档的形式，在后面需求持续迭代的项目中，显得尤为重要和高效。

如何运行起来？（Springboot集成Swagger）

1、新建Springboot项目-web

2、导入相关jar包

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2