使用 Spring REST Docs 生成 Swagger 客戶端

Question

我看過這個 Spring REST Docs -視頻

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

我們喜歡 Spring Rest 文檔可以為生成 REST API 文檔所做的事情，以及我們不必在控制器代碼中添加像 @ApiResponse 或 @ApiOperation 這樣的大搖大擺的注釋這一事實。 以及文檔現在與代碼一起存在的事實。

但是如果使用 Spring Rest 文檔，我們將錯過為我們的 API 自動生成的 Swagger-UI（當我們使用 swagger 集成時）。

Spring REST 文檔是否可以生成像 Swagger UI 這樣的測試 UI。

Answer 1

這直接違背了 Spring REST Docs 的設計思想和意圖。 它的主要目標之一是將文檔與單元測試相關聯，因此即使您在 REST 合同中進行邏輯或簽名更改，您也知道您的文檔堅如磐石。

此外，您鏈接到的視頻提供了許多示例，說明自動化文檔生成如何產生大量不需要的意外輸出。

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

Answer 2

該項目從 Spring REST Docs 生成 OpenAPI 規范。

https://github.com/ePages-de/restdocs-api-spec