接口文档——Swagger

Swagger

接口文档对于前后端开发人员都十分重要。尤其近几年流行前后 端分离后接口文档又变成重中之重。接口文档固然重要，但是由于项 目周期等原因后端人员经常出现无法及时更新，导致前端人员抱怨接 口文档和实际情况不一致
很多人员会抱怨别人写的接口文档不规范，不及时更新。当时当 自己写的时候确实最烦去写接口文档。这种痛苦只有亲身经历才会牢记于心
如果接口文档可以实时动态生成就不会出现上面问题
Swagger 可以完美的解决上面的问题

Open API

Open API 规范(OpenAPI Specification)以前叫做 Swagger规范，是 REST API的API 描述格式。 Open API 文件允许描述整个 API，包括：

• 每个访问地址的类型。POST 或 GET
• 每个操作的参数。包括输入输出参数
• 认证方法
• 连接信息，声明，使用团队和其他信息。

Open API 规范可以使用 YAML 或 JSON 格式进行编写。这样更利于我们和机器进行阅读。
OpenAPI 规范（OAS）为RESTfulAPI 定义了一个与语言无关的标 准接口，允许人和计算机发现和理解服务的功能，而无需访问源代码， 文档或通过网络流量检查。正确定义后，消费者可以使用最少量的实现逻辑来理解远程服务并与之交互。
然后，文档生成工具可以使用 OpenAPI 定义来显示 API，使用各 种编程语言生成服务器和客户端的代码生成工具，测试工具以及许多 其他用例

Swagger 简介

Swagger 是一套围绕 Open API 规范构建的开源工具，可以帮助设计，构建，记录和使用 REST API
Swagger 工具包括的组件：

• Swagger Editor ：基于浏览器编辑器，可以在里面编写 Open API 规范。类似 Markdown 具有实时预览描述文件的功能。
• Swagger UI：将 Open API 规范呈现为交互式 API 文档。用可视化 UI 展示描述文件。
• Swagger Codegen：将 OpenAPI 规范生成为服务器存根和客户端 库。通过 Swagger Codegen 可以将描述文件生成 html 格式和 cwiki 形 式的接口文档，同时也可以生成多种言语的客户端和服务端代码。
• Swagger Inspector：和 Swagger UI 有点类似，但是可以返回更多信息，也会保存请求的实际参数数据。
• Swagger Hub：集成了上面所有项目的各个功能，你可以以项目和版本为单位，将你的描述文件上传到 Swagger Hub 中。在 Swagger Hub 中可以完成上面项目的所有工作，需要注册账号，分免费版和收费版
  使用 Swagger，就是把相关的信息存储在它定义的描述文件里面 （yml 或 json 格式），再通过维护这个描述文件可以去更新接口文档， 以及生成各端代码

Springfox

使用 Swagger 时如果碰见版本更新或迭代时，只需要更改 Swagger 的描述文件即可。但是在频繁的更新项目版本时很多开发人 员认为即使修改描述文件（yml 或 json）也是一定的工作负担，久而 久之就直接修改代码，而不去修改描述文件了，这样基于描述文件生 成接口文档也失去了意义。
Marty Pitt 编写了一个基于 Spring 的组件 swagger-springmvc。 Spring-fox 就是根据这个组件发展而来的全新项目。
Spring-fox 是根据代码生成接口文档，所以正常的进行更新项目版本，修改代码即可，而不需要跟随修改描述文件。
Spring-fox 利用自身 AOP 特性，把 Swagger 集成进来，底层还是 Swagger。但是使用起来确方便很多。 所以在实际开发中，都是直接使用 spring-fox。

Swagger 用法

• 导入 Spring-fox 依赖
  在项目的 pom.xml 中导入 Spring-fox 依赖。其中 springfox-swagger2 是核心内容的封装。springfox-swagger-ui 是对 swagger-ui 的封装。

<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</version> 
</dependency>

• Controller
  编写 SpringBoot 项目，项目中 controller 中包含一个 Handler，测试项目，保证程序可以正确运行

@RestController 
@RequestMapping("/people")
public class DemoController {
    
	@RequestMapping("/getPeople") 
	public People getPeople(Long id, String name){
    
		People peo = new People()