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