Spring-Restdocs

1、概览 API 文档在团队开发中极其重要，特别是在 API 接口及其复杂的情况下，良好的 API 文档不仅能提升开发效率，还能显示产品的质量。如果一家公司的 API 文档写得马马虎虎，那么它的 API 也可能写得马马虎虎。 程序员都讨厌写自己文档和别人不写文档。 本文将带你了解如何使用 Spring REST Docs 自动地生成 API 文档。 2、API 接口 一个简单 API 如下： @RestController @RequestMapping("/books") public class BookController { private final BookService service; public BookController(BookService service) { this.service = service; } @GetMapping public List<Book> getBooks(@RequestParam(name = "page") Integer page) { return service.getBooks(page); } } 该 API 返回系统中的 Book 数据。不过，由于可用图书数量庞大，不可能一次性返回所有。所以给客户端提供了一个查询参数 page，用于控制数据分页。 而且，需要把该参数设置为必须参数（默认就是必须参数），避免客户端一次性请求过多数据。如果客户端未提交该查询参数，就会收到状态为 400 的错误提示。 3、文档 编写文档的通常方法是 “手写文档”，这意味着开发人员必须把同一件事写两遍。首先写代码，然后再写对应的文档。太麻烦！ 文档是一种相当正式的文件，其目标是清晰明了，并不需要太多花里胡哨的东西。因此，我们可以根据代码生成文档，这样就不用重复写同样的东西，而且所有的改动都会反映在文档中。 我们可以通过 Spring REST Docs 来生成 API 文档。不过，它不是从代码中生成文档，因为代码没有提供太多上下文，而是从测试中生成文档。这可以表达相当复杂的案例和示例。另一个好处是，如果测试失败，文档也不会生成。

1、概览 Spring REST Docs 和 OpenAPI 3.0 是为 REST API 创建 API 文档的两种方法。 在本教程中，我们将探讨它们的相对优缺点。 2、前世今生 Spring REST Docs 是由 Spring 社区开发的一个框架，用于 为RESTful API 创建准确的文档。它采用了测试驱动的方法，文档可用 Spring MVC tests、Spring Webflux 的 WebTestClient 或 REST-Assured 形式编写。 运行测试的结果会生成 AsciiDoc 文件，可以使用 Asciidoctor 将它们组合在一起，生成描述 API 的 HTML 页面。由于它遵循 TDD 方法，Spring REST Docs 自动带来了许多优势，例如减少代码错误、减少重复工作和更快的反馈周期等。 而，OpenAPI 是一种诞生于 Swagger 2.0 的规范。截至本文撰写时，其最新版本为 3.0，并有许多已知的 实现。 与其他规范一样，OpenAPI 也为其实现制定了一些基本规则。简而言之，所有 OpenAPI 实现都应该以 JSON 或 YAML 格式的 JSON 对象生成文档。 还有 许多工具 可以接收 JSON/YAML，并输出 UI 界面来可视化和导航 API。这在验收测试时非常有用。在这里的代码示例中，我们将使用 Springdoc - 一个用于 OpenAPI 3 和 Spring Boot 的框架。