在Spring REST Docs中包含“試用”表單

Question

我開始使用Spring REST Docs，但是我錯過了一個強大的功能……“嘗試一下！” 按鈕，其中包含用於測試API的HTML表單。 我知道卷曲鏈接； 但我通常使用搖搖欲墜的形式。 Spring REST Docs中有沒有簡單的方法可以做到這一點？ 謝謝

Answer 1

我通過創建一個將Spring REST Docs cURL代碼片段轉換為Postman集合的工具自己解決了該問題。 它以npm軟件包的形式提供： https ://www.npmjs.com/package/restdocs-to-postman，可在命令行上使用並用作庫。 這是https://github.com/spring-projects/spring-restdocs/issues/47的一種解決方案。 我認為像Postman這樣的工具可以很好地嘗試API。

編輯：有從郵差和失眠到Swagger的轉換器。 因此，通過兩次轉換（將restdocs轉換為Postman / Insomnia，將Postman / Insomnia轉換為Swagger），可以轉換為Swagger游樂場。 這不是最佳方法，但是可以。

轉換器示例：

• 郵差到Swagger： https ： //apimatic.io/ （帶試用版的付費服務）
• 失眠招搖： https : //github.com/mlabouardy/swaggymnia （MIT許可證）

編輯2：我已經創建了有關如何從Spring REST Docs中創建Swagger操場的說明： https : //github.com/fbenz/restdocs-to-swagger這需要一些步驟，如果直接使用Spring REST Docs，它將更加簡單產生Swagger文件，但是它可以工作並且可以自動化。

Answer 2

不，我相信它可以提供最接近的是curl用一個例子請求。 有一個開放的增強功能可提供Postman集合， 網址為https://github.com/spring-projects/spring-restdocs/issues/47 ，但是沒有Swagger的try it out!簡單try it out!

也與此票證有些相關， https://github.com/spring-projects/spring-restdocs/issues/213 ，

我很想嘗試增加對生成Swagger規范的支持。 當您將Swagger描述為提供“ API游樂場”時，您已經做出了非常重要的區分，而其他許多人則沒有。 我堅信Swagger的UI不能替代API文檔，因此使用它對服務或其用戶不利。

我擔心的是，如果Spring REST Docs為生成Swagger規范提供了支持，那么人們將使用該規范填充Swagger的UI並考慮將其服務記錄在案。 這是權衡信任人們做正確的事情，而不是鼓勵人們用腳射擊自己的問題。