Swagger UI OpenAPI 3，查詢參數顯示為 object 而不是值可變字段

[英]Swagger UI OpenAPI 3, query parameters displayed as an object instead of value-changeable fields

以前在 SpringBoot v2.5.7 中，我有這個 Spring REST controller 方法。 它有一個TestCriteria類型的 DTO，作為路徑參數。@GetMapping(path = "/test") public void test(TestCriteria testC ...

Swashbuckle - 如何更改服務的顯示標題？

[英]Swashbuckle - How do I change the displayed title of the service?

當我使用 swashbuckle 運行 .NET Core 服務時，它顯示的標題（在所有資源之上）源自程序集名稱。 如何指定我自己的標題出現在 swagger 頁面上？ （頁面上顯示的標題與文檔標題不同，可以通過傳入app.UseSwaggerUI()方法的options.DocumentTit ...

從 Intellij 運行時如何自動打開 Spring Boot 應用程序的 Swagger 頁面？

[英]How to open automatically the Swagger page of a Spring Boot app when running from Intellij?

在我的 Spring Boot 應用程序中，我有一個 Swagger 頁面。 我希望在我從 IntelliJ 啟動應用程序后，它也會自動運行瀏覽器並打開 Swagger 頁面。 可以嗎？ ...

從應用程序屬性加載文件時無法加載 api 定義

[英]Failed to load api definition when loading files from application properties

我有一個通過 restdocs 生成並轉換成這種格式的 openapi 文件。 它們被添加到資源文件夾中，屬性文件指向它們的格式，但是，swagger 加載失敗，我不確定我還缺少什么。 非常感謝。 ...

Swagger UI 給我這個錯誤消息：無法推斷基數 url

[英]Swagger UI gives me this error message: Unable to infer base url

每當我嘗試在本地主機上打開我的 Swagger UI 文檔時，我該怎么做才能擺脫這條錯誤消息： 無法推斷 base url。這在使用動態 servlet 注冊或 API 在 API 網關后面時很常見。 錯誤對話框的屏幕截圖 ...

如何用我已有的 openapi 更改 swagger.json 文件

[英]How can change swagger.json file with my openapi which I already have

我有一個示例 restapi 項目，我還有另一個針對我的 API 的開放式 API 文檔。 I want to replace generated swagger.json with my open API, but I couldn't find swagger.json in my proje ...

無法將“[]”添加到@Query 名稱。 嘗試了多種方式

[英]Unable to add '[]' to @Query name. Tried multiple ways

我在 API 文檔中使用@nestjs/swagger 。 當 swagger 發出請求時，我希望我的 queryParam 是features[]而不是features 。 Nest 在路由處理程序和文檔中自動搜索@Query 。 SwaggerModule 搜索路由處理程序中的所有@Body ...

當我嘗試在 swagger CodGen 中執行 function 時出現錯誤 500

[英]i'm getting error 500 when i'm trying to perform a function in swagger CodGen

我正在嘗試構建一個 API，我正在使用 swagger 編輯器、swagger gen 和 swagger UI。 我有一個來自 swagger 編輯器的 YAML 文件，我生成了一個 python-flask 服務器，我運行了服務器並且它工作正常，問題出在我的頁面上我有幾個端點當我想嘗試端點時我 ...

TypeError: Object 類型 'type' 不是 JSON 可序列化

[英]TypeError: Object of type 'type' is not JSON serializable

該代碼在 Postman 中運行良好，並提供有效響應，但無法生成 OpenAPI/Swagger UI 自動文檔。class Role(str, Enum): Internal = "internal" External = "external" class Info(Bas ...

使 Swagger-UI 顯示操作參數類型的表單

[英]Make Swagger-UI show a form for operation parameter types

我已經設置了一個 web API 和 ASP.NET Core 和 Swashbuckle。 我所有的控制器和動作都正確顯示，我可以嘗試一下。 對於像字符串這樣的簡單操作參數，會顯示一個表單，我可以在發送請求之前在該表單中輸入每個參數值。 但是，如果該操作需要一個 class 實例（數據結構）作為參 ...

怎么處理<see /> Swagger 中的 XML 文檔標簽？

[英]How to handle <see /> XML documentation tags in Swagger?

我有一個 ASP.Net Web API 和 XML 文檔，包括許多&lt;see /&gt;標簽。 我最近在解決方案中添加了 Swagger（Swashbuckle UI 東西），並注意到它不處理像&lt;see /&gt;這樣的 XML 標簽。 在網上四處看看后，我發現了這個 - https: ...

使用 ASP.NET Core 6 Swagger UI 時出錯 Web API 自定義路由

[英]Getting error for Swagger UI with an ASP.NET Core 6 Web API with custom routing

我為我的 ASP.NET Core 6 Web API 定制了路由： 我在 Swagger 配置中進行了此更改： 現在，在嘗試運行瀏覽至http://localhost:5113/ForecastService/swagger/index.html時，出現錯誤： 找不到 http://localho ...

Pydantic model 帶一個選項標記的 Union 字段已棄用

[英]Pydantic model with Union field with one option mark as deprecated

我有一些 Pydantic 模型，其中的字段是不同模型的聯合。 我正在尋找一種方法來棄用某些聯合模型。 我可以使用以下方法棄用整個字段： Field(default=None, deprecated=True) 但我發現沒有辦法在其中一個可能的值上做到這一點。 例如，在下面的示例中，是否可以將 Si ...

我們可以有兩個@PathVariable 嗎？ 一個作為實際路徑變量，另一個用於 swagger 以將其記錄為已棄用？

[英]Can we have two @PathVariable. One as the actual Path Variable and other for swagger to document it as Deprecated?

我正在嘗試更改 REST 調用的 @PathVariable。 現有路徑變量由三個參數組合而成。 更改是處理由兩個參數組合形成的路徑變量。 我需要將此更改記錄在 swagger 中，之前顯示為已棄用。 我嘗試將兩個路徑變量與一個路徑變量一起用作@Deprecated，如下所示 已將請求映射值從/a ...

Swagger 在使用 ProducesResponseType 時拋出異常

[英]Swagger is throwing exception when ProducesResponseType is used

我正在使用 .Net 7 和 Swagger 作為 Api 和文檔。 我在使用“ProducesResponseType”時遇到問題。 它正在拋出下面的異常。 這是我用來裝飾我的 controller 的東西。 我正在使用的課程如下 我得到的例外是 InvalidOperationException ...

如何繞過令牌訪問瀏覽器的 swagger-UI

[英]How can I bypass Token to access swagger-UI for Browser

如何繞過令牌訪問瀏覽器的 swagger-UI。 我可以通過 postman 向 Swagger-UI 發出請求。 當我從瀏覽器發出請求時，我得到一個錯誤，因為它請求令牌。 我搜索了很多但無法弄清楚。 我該如何解決？ pom.xml 主 class 保安 class ...

在 OpenAPI 中啟用“試用”，這樣就無需單擊

[英]Enable "Try it out" in OpenAPI so that no need to click

我正在使用 FastAPI 和 OpenAPI/Swagger UI 來查看和測試我的端點。 每次我第一次使用端點時，為了測試它，我必須先單擊Try it out按鈕，這變得很乏味。 有沒有辦法讓它消失並能夠立即測試端點？ ...

Swagger-ui空白白屏（Spring Boot-Swagger）

[英]Swagger-ui blank white screen (Spring Boot - Swagger)

當我將 Swagger 集成到 spring 項目中時，出現 Swagger 空白頁。 當我嘗試使用以下 url 撥打 Swagger 時，會出現一個空白頁面。 http://localhost:8081/swagger-ui.html pom.xml 主 class 應用程序.propert ...

Azure Function 在本地和 Azure 上工作的代理

[英]Azure Function Proxy that works locally and on Azure

我正在創建一個 Azure Function 將公開一些 API。 .Net7，Azure 功能版本 4，隔離。 主機.json： local.settings.json： 我添加了端點，添加了 swagger，一切正常。 現在我正在嘗試用 swagger ui 替換歡迎頁面。 我嘗試了兩種方法 ...

Swagger UI 獲取 403（openapi v3）

[英]Swagger UI getting 403 (openapi v3)

我將 springdoc-openapi-ui 用於 API 文檔 並且，遵循 Spring 引導安全配置。 Spring 引導父版本：3 當我嘗試訪問 http://localhost:8080/swagger-ui.html 時，我得到了 403。 有人面臨類似的問題嗎？ 可能是什么問題？ ...