【发布时间】:2014-03-25 18:35:18
【问题描述】:
您好,我正在使用 Apiary 来维护我的 REST API 的文档,因为我们的代码库正在增长,我们的 API 文档也越来越大。将我们所有的 API 放在一个蓝图文件中变得非常困难,有什么方法可以正确地将它们组织成多个文件并在 apiary 中显示它们。
【问题讨论】:
您好,我正在使用 Apiary 来维护我的 REST API 的文档,因为我们的代码库正在增长,我们的 API 文档也越来越大。将我们所有的 API 放在一个蓝图文件中变得非常困难,有什么方法可以正确地将它们组织成多个文件并在 apiary 中显示它们。
【问题讨论】:
是的,有一种未记录的方式(它很丑,但它有效):如果您连接到 github,您可以在存储库的根目录中创建一个名为 apiary.manifest 的文件。
在其中,您可以放置以换行符分隔的相对路径列表,这些路径按该顺序连接并显示在您的 apiary 子域上。
但是请注意,养蜂场目前不提供在养蜂场编辑器中进行编辑的好方法。如果你把它保存在那里,你只会在你的 repo 中保存为apiary.apib 的串联版本(这就是它没有记录的原因)。
您必须使用编辑器进一步编辑蓝图,即使用apiary plugin 进行 sublime。
【讨论】: