消息傳遞API的Swagger UI

Question

我想知道以下是否可能。

Swagger是差不多我需要文檔基於消息的API。例如，對於Command Message，我想說「命令」而不是「發佈」，而不是「路徑」，我希望命令的名稱。

spec mentions供應商擴展可能使用「x-」屬性，但我1）找不到如何做到這一點的任何示例和2）不確定使用這些屬性是否會幫助我實現我的目標。

任何人都可以指向我一些資源，可以幫助我移動？

Answer 1

Swagger旨在記錄REST基於HTTP動詞的API。你不能替代動詞或發明新動詞。

供應商擴展允許添加規範不允許的其他信息，但最終它仍然適用於REST API。

從我收集的內容來看，你試圖描述一些不同的東西。

我們歡迎Swagger提供額外道路的建議（即覆蓋非REST API），爲此，我建議在swagger-spec存儲庫上打開一個問題。