我很高兴地宣布 Spring REST Docs 1.0.0.RELEASE 已经发布。它可以在 Maven Central 和我们的 发布仓库 中获取。

什么是 Spring REST Docs？

Spring REST Docs 帮助您记录 RESTful 服务。它结合了使用 Asciidoctor 编写的 手动文档和使用 Spring MVC Test 生成的自动代码片段。这种方法使您摆脱了像 Swagger 这样的工具带来的限制。它帮助您生成准确、简洁且结构良好的文档。这些文档可以让您的用户轻松获取他们需要的信息。

如果您想查看使用 Spring REST Docs 生成的文档，请查看示例 API 指南 和 入门指南，它们展示了一个简单的 RESTful 笔记服务。

入门

要开始使用 Spring REST Docs，请参阅 入门部分 的 参考文档。

感谢

我衷心感谢 Spring 社区的成员，他们帮助塑造了 Spring REST Docs 1.0。如果没有你们的特性建议、拉取请求和错误报告，它将不会是现在的样子。谢谢。