揚鞭客戶代與Spring REST文檔

Question

我看到這個春天REST文檔 - video

我們正在做的春天啓動的項目和使用springfox庫所概述產生揚鞭的UI和招搖文檔here

我們喜歡什麼彈簧安置文檔可以生成REST API文檔，事實上，我們沒有添加招搖註解像@ApiResponse或@ApiOperation在我們的控制器代碼做。而且文檔現在也與代碼一起存在。

但如果用彈簧安置文檔去，我們會錯過這個就會自動爲我們的API生成（當我們使用招搖集成）的揚鞭的UI。

是否有可能在春季REST文檔生成像揚鞭UI測試UI。

Answer 1

這幾乎直接違背了春REST文檔的設計理念和意圖。其中一個它的主要目標是，文檔被綁定到單元測試，所以你知道你的文檔是穩如磐石，甚至當你在做你的REST契約邏輯或簽名的變化。

此外，您鏈接的視頻提供了大量關於自動文檔生成如何產生大量不希望的非預期輸出的示例。

因此，您可以選擇做更多的工作來獲得更好的文檔，或者選擇完全自動化的選項來節省時間並獲得可行性，但文檔質量較差。這是你的首要任務。