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

时间:2016-06-07 16:41:12

标签: webhooks apiblueprint apiary.io apiary

我刚开始使用api蓝图,使用apiary为我们的api生成文档。我们有一个REST api和一些webhooks。 REST api很容易创建,但我无法弄清楚如何最好地为webhook生成文档。

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

到目前为止,我唯一能想到的就是将webhook记录为REST资源。这感觉有点奇怪,因为通常webhook文档只是有效载荷信息,但也许这是最好的选择。

有人这样做吗?或者也许有更好的工具可用于此?

最终会喜欢像github那样的东西:https://developer.github.com/webhooks/

1 个答案:

答案 0 :(得分:3)

即使APIBlueprint没有任何内置构造来记录webhook,请记住,您始终可以使用markdown来描述您的终点。

有了这个" power",你应该能够表达你的所有想法。

如果您查看MovieDb Api,您可以看到他们如何使用降价表来表达可能与ApiBlueprint语言本身不相符的内容。

我希望这有帮助!