从spring rest docs生成ascii doc api文档

时间:2018-01-04 16:40:23

标签: java spring asciidoctor spring-restdocs

使用Spring rest文档,您可以生成一系列精彩的asciidocs作为单独的片段。

http://www.baeldung.com/spring-rest-docs在描述我遵循的流程方面做得很好。

生成片段后,我根据教程使用asciidoctor-maven-plugin将它们组合成一个文档进行文档化。

有没有办法生成单个.adoc文件而不是之前提到的html文件?

在配置中,它允许您使用以下命令指定“后端”:

<backend>html</backend>

http://asciidoctor.org/docs/convert-documents/#selecting-an-output-format https://github.com/asciidoctor/asciidoctor-maven-plugin

...但我希望将asciidoc保留为最终文件格式。

我找到的最接近的评论是:https://github.com/asciidoctor/asciidoctor/issues/168#issuecomment-58861372

...但我不太明白如何将它应用到我的情况中。

1 个答案:

答案 0 :(得分:1)

如果我理解您的链接正确,则无法将提供的解决方案与maven插件一起使用。目前它不支持导出asciidoctor文件。你必须

  1. 安装ruby和ascidoctor gem
  2. 下载脚本https://raw.githubusercontent.com/asciidoctor/asciidoctor-extensions-lab/master/scripts/asciidoc-coalescer.rb
  3. 使用ruby运行脚本asciidoc-coalescer.rb your_file_name.adoc&gt; single_file.adoc
  4. 祈祷脚本有效,你不会遇到你发布的帖子中遇到的麻烦。您的输出应该是single_file.adoc