Overview
Learn
Samples
Spring REST Docs helps you to document RESTful services.
It combines hand-written documentation written with Asciidoctor and auto-generated snippets produced with Spring MVC Test. This approach frees you from the limitations of the documentation produced by tools like Swagger.
It helps you to produce documentation that is accurate, concise, and well-structured. This documentation then allows your users to get the information they need with a minimum of fuss.
Spring Boot Config
Spring Boot provides an @AutoConfigureRestDocs annotation to leverage Spring REST Docs in your tests.
Spring Initializr
Quickstart Your Project
Bootstrap your application with Spring Initializr.
translate:
翻译:
Spring REST Docs帮助您记录RESTful服务。
它结合了使用ascidoctor编写的手工文档和使用Spring MVC测试生成的自动生成的代码片段。这种方法使您摆脱了由诸如Swagger之类的工具生成的文档的限制。
它帮助您生成准确、简洁、结构良好的文档。然后,此文档允许用户以最少的麻烦获得所需的信息。
弹簧靴配置
Spring Boot提供了一个@AutoConfigureRestDocs注释,可以在测试中利用Spring REST文档。
弹簧初始化器
快速启动项目
使用Spring初始化器引导应用程序。