如何在 Apiary/API 蓝图中记录 Webhook
How to document Webhooks in Apiary/API Blueprint
我刚开始使用 api 蓝图，使用 apiary 为我们的 api 生成文档。我们有一个 REST api 和一些 webhook。 REST api 很容易创建，但我不知道如何最好地为 webhook 生成文档。
我们想在我们的 webhook 和我们的 REST 之间共享数据结构 api。
到目前为止，我唯一能想到的就是像记录 REST 资源一样记录 webhook。这感觉有点奇怪，因为通常 webhook 文档只是有效负载信息，但也许这是最好的选择。
有人这样做吗？或者也许有更好的工具可以做到这一点？
最终会喜欢 github 所做的事情：https://developer.github.com/webhooks/
即使 APIBlueprint 没有任何内置构造来记录 webhook，请记住，您始终可以使用 markdown 来描述您的端点。
有了那个"power"，你应该可以表达你所有的想法了。
如果您查看 MovieDb Api，您会看到他们如何使用降价表来表达可能不适合 ApiBlueprint 语言本身的内容。
希望对您有所帮助！
V.
我刚开始使用 api 蓝图，使用 apiary 为我们的 api 生成文档。我们有一个 REST api 和一些 webhook。 REST api 很容易创建，但我不知道如何最好地为 webhook 生成文档。
我们想在我们的 webhook 和我们的 REST 之间共享数据结构 api。
到目前为止，我唯一能想到的就是像记录 REST 资源一样记录 webhook。这感觉有点奇怪，因为通常 webhook 文档只是有效负载信息，但也许这是最好的选择。
有人这样做吗？或者也许有更好的工具可以做到这一点？
最终会喜欢 github 所做的事情：https://developer.github.com/webhooks/
即使 APIBlueprint 没有任何内置构造来记录 webhook，请记住，您始终可以使用 markdown 来描述您的端点。
有了那个"power"，你应该可以表达你所有的想法了。
如果您查看 MovieDb Api，您会看到他们如何使用降价表来表达可能不适合 ApiBlueprint 语言本身的内容。
希望对您有所帮助！
V.