如何使 Spring Rest Docs 看起来像 Swagger？答案

【问题标题】：How Can I Make Spring Rest Docs Look Like Swagger?如何使 Spring Rest Docs 看起来像 Swagger？
【发布时间】：2018-08-15 05:32:53
【问题描述】：

我已经开始在一个项目中使用 Spring Rest Docs，但是公司的其他 API 仍在使用 Swagger/OpenAPI，这导致了样式不一致。

通常的 Swagger 视图（例如 https://petstore.swagger.io）对于每个 url 和 CSS 着色 GET/POST/PUT/DELETE 等都有可折叠部分。

我应该能够在 adoc 中使用一行自定义 asciidoctor

:stylesheet: custom.css

是否有现有的 Spring Rest Docs 模板提供类似于默认 Swagger 输出的输出？

您能否在 asciidoctor 输出中添加 javascript 以动画化某些文档，例如可折叠的 url 部分？

【问题讨论】：

标签： spring-restdocs

【解决方案1】：

这实际上是任何 Asciidoctor 问题，因此您可能希望将其标记为此类。

是否有现有的 Spring Rest Docs 模板提供类似于默认 Swagger 输出的输出？

我不知道。

您能否在 asciidoctor 输出中添加 javascript 以动画化某些文档，例如可折叠的 url 部分？

是的，您可以将 JavaScript 添加到由 Asciidoctor 生成的 HTML 中。在this question 的答案中描述了一种方法。另一种方法是使用DocinfoProcessor 将JavaScript 注入到生成的HTML 的<head> 中。后一种方法的一个优点是它允许将功能打包为依赖项并重用。你可以看一个相当简单的DocinfoProcessorhere的例子。

【讨论】：

【解决方案2】：

看看这个 Github 项目：https://github.com/ePages-de/restdocs-api-spec

我公司的一些团队正在使用它从我们的 Sprint Rest Doc 测试中生成 OpenAPI 文档。

【讨论】：