8. Spring Boot 2.5 实战 API 帮助文档 Swagger

Spring Boot 2.5 实战 API 帮助文档Swagger

内容简介：
一、REST API 帮助文档
二、REST API 自动生成帮助文档 Swagger

一、REST API 帮助文档

目前大型移动互联网平台，像淘宝、微信，抖音、拼多多，包括滴滴打车、美团等，
都是前后端分离的架构，我们叫微服务架构。
Swagger 是自动化 API 文档的生成工具，这个工具之前是 Spring Boot 项目来进
行集成，现在使用 Spring Boot 项目做后端开发，写 API 的代码的机会比较多，咱们把
这个工具给大家介绍一下。
作为一个快速开发框架，是 Spring Boot 提供了自己的一套 API 的文档工具，目前
来看，Swagger 使用比较多，这几年来普及率非常高，因为它非常方便，它的文档生成
基本上都是自动化，只需要加一个简单的处理就可以。

对于后端开发来说，不需要自己专门写一套 word 文档，发给前端，前端再自己去
测试，再调进来后台 API。Swagger 文档部署完以后，前端可以直接拿到，然后进行在
线调试，非常方便。简化前后端协助，协助避免出错。

二、REST API 自动生成帮助文档 Swagger

1. Swagger 自动化文档工具

1）Swagger 是一个完整的 API 生态，工具，规范，代码生成。
2）用于描述，生成，使用和可视化 RESTful Web 服务。
3）Swagger API project 2011 Tony Tam 创立 最早 Java 版。
4）SmartBear Software 公司支持，Apache License 2.0。
5）OpenAPI Spec。
6）Swagger and OAS。
7）Swagger 2 to OpenAPI 3。
8）捐赠给 linux 基金会。
9）行业标准规范。
10）Swagger Tools 一套工具：设计、开发、测试、监控、治理。