【问题标题】:How to add image to REST docs api documentation如何将图像添加到 REST docs api 文档
【发布时间】:2020-01-03 13:48:12
【问题描述】:

我正在使用 Spring Rest Docs 为我的 API 生成 API 文档。

现在我想在此文档中添加一张图片。我知道如何在 asciidoctor 文件中链接图像,并且在 IntelliJ Idea 中预览会显示图像,但是当我使用 Rest Docs 和 Gradle 生成 API 文档时,图像不会显示。

我需要做什么才能在生成的 API 文档中获取图像?

【问题讨论】:

  • 在某些文档中包含图像时,它应该像标准 Asciidoctor 一样工作。您能否分享一个示例来说明您的尝试?

标签: gradle asciidoctor spring-restdocs


【解决方案1】:

实际上完成这项工作相当简单。感谢 Andy Wilkinson 的评论,我重新研究了文档。

在将其重命名为“images”后,我使用了一个相对于 .adoc 文件的名为“resources”的文件夹,而不是将该文件夹命名为“images”。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2013-04-04
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-11-28
    相关资源
    最近更新 更多