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

什么是 Spring REST Docs？

Spring REST Docs 帮助您记录 RESTful 服务。它将使用 Asciidoctor 编写的手动文档和使用 Spring MVC Test 自动生成的代码片段相结合。 这种方法使您摆脱了像 Swagger 这样的工具的限制。 它可以帮助您生成准确、简洁且结构良好的文档。 然后，此文档允许您的用户以最小的麻烦获取他们需要的信息。

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

入门指南

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

感谢

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