通過spring-rest-docs構建swagger2規範

Question

我喜歡使用TDD方法來記錄spring-rest-docs中的restful api。不過，我喜歡Swagger規範支持的「API Playground」功能。我希望有一種兩全其美的方法。

有沒有辦法從spring rest文檔構建swagger2規範？可能會通過構建自定義請求/響應預處理器。

你有什麼想法或建議嗎？

Answer 1

目前在Spring REST Docs中沒有對此的支持。 issue that you opened將跟蹤添加此功能的可能性。與此同時，你最好的選擇是看編寫一個自定義的Snippet實現，它生成（部分）Swagger規範。

通常，Spring REST Docs片段處理記錄單個資源，而Swagger規範描述整個服務。這意味着Swagger規範Snippet實現將需要以某種方式積累狀態，然後才能生成完整的規範。有很多方法可以做到這一點（在內存中，在後處理步驟中組合多個文件等）。我不清楚，一種方法顯然是正確的，所以一些實驗是有用的。如果你做了一些實驗，請評論你在研究結果中打開的問題。