2014-03-25 31 views
9

您好我正在使用Apiary维护我的REST API的文档,因为我们的代码基础越来越多,我们的API文档越来越大。将所有的API放入单个蓝图文件中变得非常困难,我们是否有任何方法可以将它们正确地组织到多个文件中并在蜂房内显示它们。蜂房多个蓝图文件合并为一个api

回答

11

是的,有一种没有文档记载的方式(它很丑,但是很有效):如果你连接到github,你可以在你的仓库的根目录下创建一个名为apiary.manifest的文件。

在里面,您可以放置​​以换行顺序连接并显示在您的apiary子域中的相对路径的换行符分隔列表。

请注意,但是,养蜂场目前不提供一个很好的方式来编辑在养蜂场的编辑器。如果您将其保存在那里,则只会将连接版本保存为apiary.apib回到您的回购库(这就是为什么它没有记录)。

您必须使用自己的编辑器进一步编辑蓝图,即使用apiary plugin来升华蓝图。

+0

你是否会用cli客户端来支持它?谢谢:) – mojzis

+2

@mojzis绝对;我们只想要比清单文件更好地配置蓝图工具。 – Almad

+0

太棒了!期待 :) – mojzis

相关问题