如何將openapi本地文件加載到localhost上的swagger？ （由 restdocs 生成的文件）
[英]How to load openapi local files into swagger on localhost? (Files generated by restdocs)
我的 api 文檔由 restdocs 通過單元測試生成。 盡管它可以很好地滿足我的大部分需求，但我仍然缺乏一些不錯的 swagger 功能，所以我試圖通過將 restdocs 轉換為 swagger 來充分利用這兩個詞。嘗試了很長時間后，我終於設法在一些第三方庫的幫助下完成它（ https:// ...
Spring REST 文檔 - 在 Curl 片段中添加 p12 證書
[英]Spring REST Docs - Add p12 certificate in Curl Snippet
我正在使用 MockMVC 和 Spring REST 文檔，並試圖生成一個包含證書的 curl 片段。 我想 curl 聲明的證書部分應該類似於： --cert-type P12 --cert <cert-file-here.p12>:<password> 我嘗試使用下面的 ...
將輸入請求發送到 POST 端點的最佳實踐
[英]Best practice to send the input request to POST endpoint
我正在創建一個名為 /transactions 的 POST 端點，它應該接受以下輸入。 發送如下輸入請求的最佳做法是什么？ 我應該使用請求正文還是輸入 stream 還是純字符串？ ...
是否有將 openapi3 轉換為 Restdocs(adoc) 的解決方案？
[英]Is there any solution for converting openapi3 to Restdocs(adoc)?
我可以使用 Swagger2Markup 將 openapi2 轉換為 adoc，但它僅支持 openapi2，不支持 3。 https://github.com/Swagger2Markup/swagger2markup/issues 我讀了一些關於它的問題，我猜它仍然不支持 openapi3 ...
Spring 引導文件配置屬性
[英]Spring boot document configuration properties
我正在嘗試自動記錄我的配置屬性，以便為它的配置創建一個 html，就像 spring 引導附錄中的那個一樣。 我看到我可以在這里啟用配置元數據https://docs.spring.io/spring-boot/docs/2.6.6/reference/html/configuration-meta ...
使用 Spring 時如何使用不記名令牌進行身份驗證 Rest Docs
[英]How to authenticate with a bearer token when using Spring Rest Docs
授權模式為bearer時，是否可以使用Spring RestDocs記錄API？ 指向一個簡單示例的指針將不勝感激，它似乎在 Spring RestDocs 頁面上不可用。 謝謝 ...
[spring-rest-docs]：記錄 Map 時出現問題<object, set<object> ></object,>
[英][spring-rest-docs]: Problem documenting a Map<Object, Set<Object>>
我很難嘗試記錄以下內容： 我試圖引用我用來構建 object 的相同 map 但它沒有幫助： 我得到的錯誤是上面的部分沒有記錄在有效負載中。 我曾嘗試使用 UUDI 的通配符來記錄，但這也無濟於事感謝您的指點 ...
具有通用返回類型的 Springdoc
[英]Springdoc with a generic return type
當用戶使用 Pageable 進行查詢時，我有一個自定義頁面要返回。 這個頁面有一個通用參數，我想在我的 Swagger 文檔中指定它。 這是當前的結果： 其中elements是我的泛型類型的實例列表。 簽名 function 我實際上有：@CustomPageableAsQueryParam ...
如何以 Enum 作為密鑰條目記錄 Map？
[英]How to document a Map with Enum as key entry?
我正在為返回這種 JSON 的 REST 服務做文檔： 這表示一個Map<Mechanism, MechanismInfo> ，其中Mechanism是一個枚舉，而MechanismInfo是一個 POJO。 我只想記錄MechanismInfo class 的字段，而不管Mechan ...
如何在 uri 和查詢字符串中記錄路徑參數？
[英]How to document path parameters both in the uri and in the query string?
在 JUnit 5 測試中，我試圖用以下內容記錄我的 Spring 引導應用程序 API： 不幸的是，它沒有按我的預期工作，我面臨以下異常： 查看代碼 ( PathParametersSnippet )，在提取實際參數之前，查詢字符串似乎已從 URI 中刪除。 這解釋了錯誤消息。 有人可以幫助我構 ...
Rest 文檔用於 PUT 請求，帶有請求參數但沒有請求正文設置內容類型為 url 編碼形式
[英]Rest doc for PUT request with request param but without request body setting content type as form url encoded
我注意到 rest doc (HttpRequestSnippet.java) 將 APPLICATION_FORM_URLENCODED_VALUE 設置為帶有請求參數但沒有請求正文的 PUT 的內容類型。 這應該更正，可能會在 requestbody/content 為空時將 MEDIATYPE ...
為 spring-restdocs-asciidoctor 指定自定義片段目錄？
[英]Specify custom snippet directory for spring-restdocs-asciidoctor?
我已經使用RestDocumentationExtension配置了一個自定義片段目錄。 如何為spring-restdocs-asciidoctor指定此代碼段目錄？ ...
為共享模型創建片段
[英]Creating snippet for shared model
是否可以為不同響應結構之間共享的嵌套 bean 生成片段？ 地址模型 來自端點 1 (R1) 的響應 來自端點 2 (R2) 的響應 我想為Address模型生成一次代碼片段，然后在為 R1 和 R2 生成的代碼片段中重用它。 ...
使用 Spring Restdoc 時配置 asciidoctor
[英]Configuring asciidoctor when using Spring Restdoc
我正在采用 Spring Rest Docs 並且測試成功創建了 *.adoc 文件。 我在 src/docs/asciidoc 目錄中創建了 api-guide.doc 文件來創建 html，但是當我將 asciidoc 作為 gradle 任務運行時，它會產生以下錯誤。 我用spring初 ...
如何使用 gradle 項目在 src/docs/asciidoc 中將 generated-snippets.adoc 文件轉換為 html
[英]How to convert generated-snippets .adoc files to html in src/docs/asciidoc using gradle project
我在為我的 spring rest docs 實施我的 adoc 文件時遇到了這個問題，我的測試用例是在build/generated-snippets中創建的。 我在創建 html 時遇到問題，在哪里創建src/docs/asciidoc文件夾？ 以及運行哪個 gradle 任務來構建 html ...
如何禁用 Spring Rest 文檔
[英]How to Disable Spring Rest Docs
問題我在我的項目中使用Spring Rest 文檔。 它在開發階段很有用，但我不希望它在生產中可供普通用戶和搜索引擎使用。 研究我沒有看到帶有“nocache”和“noindex”等內容的機器人元標記。 實際上預期的可能是 spring application.property 字段，例如sprin ...
我如何在 spring auto restdocs 中記錄內部集合約束
[英]How i can document inner collection constraints in spring auto restdocs
我正在嘗試記錄 Collections（NotBlank 和 Size）的內部約束，例如： 我可以使用內置功能嗎？ PS：我在這里找到了約束解決的地方，在修改此方法后，我可以訪問所需的約束，但 NotBlank 屬於片段中的Optional 字段 ...
Spring AutoConfigureRestDocs 附加配置
[英]Spring AutoConfigureRestDocs additional configuration
我正在使用Spring REST文檔生成文檔，並且我正在使用新注釋@AutoConfigureRestDocs而不是在@BeforeEach方法中顯式定義。 以下測試目前正在運行。 但現在我需要漂亮地打印我的回復，我不想在每種方法中都這樣做。 根據 spring 文檔，可以選擇使用RestDocsM ...
如何在 spring RestDoc（asciidoc）中折疊 TOC（目錄）？
[英]How to collapse TOC(table of contents) in spring RestDoc (asciidoc)?
我使用過 SpringRestDoc 並想折疊目錄。 在我的index.adoc下面 謝謝， ...
使用 spring rest 文檔時，如何在說明中換行？
[英]When using spring rest docs, how do I make a newline in the description?
我嘗試了 \n 或 br 標記來換行，但它不起作用。 如何在描述中換行？ ...