3

apiary を使用して api のドキュメントを生成する api blueprint から始めたところです。REST API と多数の Webhook の両方があります。REST API は簡単に作成できますが、Webhook のドキュメントを生成する最善の方法がわかりません。

Webhook と REST API の間でデータ構造を共有したいと考えています。

これまでのところ、REST リソースと同じように Webhook を文書化することしか考えられません。通常、Webhook のドキュメントは単なるペイロード情報であるため、これは少し奇妙に感じられますが、おそらくそれが最良の選択肢です。

誰でもこれを行いますか？それとも、これを行うためのより良いツールがありますか?

最終的には、github のようなものが好きです: https://developer.github.com/webhooks/

4

1 に答える 1

3

APIBlueprint に Webhook を文書化するための組み込み構造がない場合でも、いつでもマークダウンを使用してエンドポイントを記述できることに注意してください。

その「力」があれば、あなたの思いをすべて表現できるはずです。

MovieDb Apiを見ると、マークダウンテーブルを使用して、おそらく ApiBlueprint 言語自体には適合しないものを表現していることがわかります。

これが役立つことを願っています！

V.

于 2016-06-14T12:01:45.497 に答える