☰

SwaggerでWebSocketイベントまたはコールバックを文書化する方法 [closed] 質問する

tag-icon • tag-icon websocket swagger documentation
SwaggerでWebSocketイベントまたはコールバックを文書化する方法 [closed] 質問する

標準の REST を使用してリソースを取得できる設定があり、これは Swagger で簡単に文書化できます。同じリソースは、変更されると Websocket を使用してクライアントにプッシュされるため、クライアントは間隔をあけてプルする必要がありません。

しかし、これを Swagger で文書化するにはどうすればよいでしょうか? そもそも可能ですか? そうでない場合、REST API と Websocket 部分の両方を文書化するために他にどのようなツールをお勧めしますか?

ベストアンサー1

オープンAPI3(別名 Swagger 3) では、応答形式がアップグレードされ、コールバックの概念が追加され、Webhook を定義できるようになりました。ドキュメントのこの部分をご覧ください。応答フォーマット。

でスワガー2私がいつもやっていることは、コールバックから期待するものとまったく同じものを実装する API メソッドを実装し、コールバックを待機する元のメソッドでそれを参照することです。そのため、Swagger 仕様を使用して、どのコンシューマーも少なくとも私が期待しているメッセージの形式を確認できます。

おすすめ記事