我们希望将图像集成到 Apiary 上的 API 文档中,作为记录底层应用程序架构或说明示例工作流/序列图的一种方式。然而,通过Apiary 文档和API 蓝图规范进行搜索似乎并没有产生任何关于如何做到这一点的结果。
是否可以将图像添加到 API 蓝图?或者这些图像是否必须在外部托管并通过 URL 引用?
David - API 蓝图基于 Markdown 语法(与包括 GitHub 评论在内的许多其他地方一样)。您可以使用以下语法将图像插入 Markdown(和 API 蓝图):
![name](/url)
这些图像确实需要在外部托管并通过 URL 引用。
如另一个答案所述:
![alternative text](/url)
或者在 linux 上获取本地图像:
![alternative text](./image.png)
但是如果要指定图片大小,直接使用html
<img src="image.png" alt="image alternative text" width="500"/>