如何向API蓝图添加图像/图表?

时间:2015-12-14 18:45:59

标签: image apiblueprint apiary.io apiary

我们希望将图像集成到Apiary上的API文档中,作为记录底层应用程序架构或说明示例工作流程/序列图的一种方式。但是,通过Apiary documentationAPI Blueprint Specification进行搜索似乎无法获得有关如何执行此操作的任何结果。

是否可以将图像添加到API蓝图?或者这些图像是否必须在外部托管并通过URL引用?

2 个答案:

答案 0 :(得分:13)

David - API Blueprint基于Markdown语法(与许多其他地方一样,包括GitHub注释)。您可以使用以下语法将图像插入Markdown(和API蓝图):

![name](/url)

这些图像确实需要在外部托管并通过URL引用。

答案 1 :(得分:0)

如另一个答案所述:

![alternative text](/url)

或在Linux上获取本地映像:

![alternative text](./image.png)

但是如果要指定图像大小,请直接使用html

<img src="image.png" alt="image alternative text" width="500"/>