如何在Apiary/API蓝图中记录Webhooks

Question

我刚刚从api蓝图开始，使用芹菜为我们的api生成文档。我们有一个REST和一些webhooks。REST很容易创建，但我不知道如何最好地为webhooks生成文档。

我们希望在webhooks和REST之间共享数据结构。

到目前为止，我唯一能想到的就是记录webhooks，就像REST资源一样。这感觉有点奇怪，因为通常web钩子文档只是有效负载信息，但也许这是最好的选择。

有人这么做吗？或者也许有更好的工具来解决这个问题？

最终会喜欢github所做的事情：https://developer.github.com/webhooks/

Answer 1

即使APIBlueprint没有任何内置构造来记录web钩子，请记住，始终可以使用标记来描述您的终结点。

有了这种“力量”，你应该能够表达你所有的想法。

如果您查看MovieDb Api，您可以看到它们是如何使用标记表来表达可能与ApiBlueprint语言本身不太匹配的内容。

我希望这能帮到你!

V。