我已经开始在项目中使用Spring Rest Docs,但是公司中的其他API仍在使用Swagger / OpenAPI,这导致样式不一致。
通常的Swagger视图(例如https://petstore.swagger.io)的每个网址都有可折叠的部分,并且CSS颜色为GET / POST / PUT / DELETE等。
我应该能够在adoc中用一行自定义asciidoctor
:stylesheet: custom.css
是否存在Spring Rest Docs的现有模板,其输出类似于默认的Swagger输出?
您可以将JavaScript添加到asciidoctor输出中以使某些文档(例如可折叠的url部分)动画化吗?
答案 0 :(得分:0)
这实际上是任何Asciidoctor问题,因此您可能希望将其标记为这样。
是否存在Spring Rest Docs的现有模板,其输出类似于默认的Swagger输出?
我不知道。
您可以将JavaScript添加到asciidoctor输出中以使某些文档(例如可折叠的url部分)动画化吗?
是的,您可以将JavaScript添加到由Asciidoctor生成的HTML中。 this question的答案中描述了一种方法。另一种方法是使用DocinfoProcessor
将JavaScript注入生成的HTML的<head>
中。后一种方法的一个优点是,它允许将功能打包为依赖项并重新使用。您可以看到一个非常简单的DocinfoProcessor
here的示例。
答案 1 :(得分:0)
看看这个Github项目:https://github.com/ePages-de/restdocs-api-spec
我公司的一些团队正在使用它从我们的Sprint Rest Doc测试中生成OpenAPI文档。