时间戳

首页 > 解决方案 > 如何使 Spring Rest Docs 看起来像 Swagger？

spring-restdocs - 如何使 Spring Rest Docs 看起来像 Swagger？

问题描述

我已经开始在一个项目中使用 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

解决方案

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

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

不是我知道的。

你可以在 asciidoctor 输出中添加 javascript 来为一些文档制作动画，比如可折叠的 url 部分吗？

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

推荐阅读