如何使用SpringBoot和Swagger快速构建API文档？

本文共计1687个文字，预计阅读时间需要7分钟。

最近在做的项目里，直接用了一个叫API的东西。controller注释里我会写我会写，这个东东我也会用。但实际我不知道这东西是什么，有点神奇。关键还把我搞迷糊了，他的注释会影响到代码。

最近在做项目的时候，一直用一个叫做API的东西，controller注解我会写，这个东西我也会用，但是我确实不知道这个东西是个什么，有点神奇。关键还坑了我一次，他的注解会影响到代码的运行，不光是起到注解的作用。所以我就研究了一下。

Swagger是什么：THE WORLD'S MOST POPULAR API TOOLING

根据官网的介绍：

Swagger Inspector：测试API和生成OpenAPI的开发工具。Swagger Inspector的建立是为了解决开发者的三个主要目标。

1、执行简单的API测试

2、生成OpenAPI文档

3、探索新的API功能

我的理解Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。简单来说，Swagger是一个功能强大的接口管理工具，并且提供了多种编程语言的前后端分离解决方案。根据我的使用，当然我只是最简单的使用，我感觉Swagger有以下几个优点：

1、Swagger可以整合到代码中，在开发时通过注解，编写注释，自动生成API文档。

2、将前端后台分开，不会有过分的依赖。

3、界面清晰，无论是editor的实时展示还是ui的展示都十分人性化，如果自己仅仅用markdown来编写，又要纠结该如何展现，十分痛苦。