標簽[swagger] - 堆棧內存溢出

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

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

Azure API 部署問題 - Swashbuckle SwaggenGen 錯誤

[英]Azure API deployment issue - Swashbuckle SwaggenGen Error

嘗試從 VS 2022 將我的應用服務部署到 Azure 時遇到問題。每次我都收到此錯誤：我使用 .NET 6 作為我的目標框架，我已經將 Swashbuckle.AspNetCore package 更新到最新版本。應用服務發布成功，但嘗試更新API時彈出錯誤。在我的項目版本中，沒有 Sta ...

有沒有辦法為 javax.ws.rs 中的所有端點定義查詢參數？

[英]Is there a way to define queryparams for all endpoints in javax.ws.rs?

我正在嘗試使用 javax.ws.rs 注釋來記錄一個已經存在的應用程序，以定義特定端點需要的標頭 (@HeaderParam) 和參數 (@QueryParam)。此信息將用於為應用程序生成 swagger 頁面。我已經確定了一組所有端點都需要的“@HeaderParam”。我需要知道是否 ...

枚舉響應是數值而不是字符串

[英]Enum response is numeric value and not string

對於我所有其他枚舉類 swagger 顯示字符串定義，但對於我在“ExceptionMiddleware”class 中使用的一個枚舉 class，它顯示數值。但在 swagger 文檔示例中，它顯示了字符串值.. 我的枚舉 class：我的其他枚舉類之一沒有這個“問題”：找不到合約時的結果 ...

如何在 Nest.js 中制作 Swagger map 未使用的實體？

[英]How to make Swagger map not used entity in Nest.js?

我有我的 Nest.js 項目，我使用 Prisma 作為 ORM。因此，實際上我不需要使用實體與數據庫通信，但我仍然想使用 Swagger 記錄這些實體。例如文件user.entity.ts ：即使我導出了這個 class，我也沒有使用它，因為 Prisma 允許這樣做。問題是雖然它沒有在 ...

如何將openapi本地文件加載到localhost上的swagger？（由 restdocs 生成的文件）

[英]How to load openapi local files into swagger on localhost? (Files generated by restdocs)

我的 api 文檔由 restdocs 通過單元測試生成。盡管它可以很好地滿足我的大部分需求，但我仍然缺乏一些不錯的 swagger 功能，所以我試圖通過將 restdocs 轉換為 swagger 來充分利用這兩個詞。嘗試了很長時間后，我終於設法在一些第三方庫的幫助下完成它（ https:// ...

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

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

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

有沒有辦法記錄如何使用 swaggerUI 保護端點？

[英]Is there a way to document how an endpoint is protected using swaggerUI?

嘿嘿。我有一個相當大的應用程序，其中包含一些端點和授權方案，為了保護它們，我為權限創建了 3 個 AuthorizeAttributes，不同租戶中的權限和參數。在訪問端點本身之前檢查它們。還有更多。我還創建了授權策略，例如，用戶需要在請求的用戶屬性中列出。現在，如果我們的 swagge ...

通過作為 Windows 服務托管的 ASP.NET Core-Web-Api 打印

[英]Printing via ASP.NET Core-Web-Api hosted as Windows Service

我是ASP.NET Core-Web-Api 的新手，也許你對我有一些提示。我使用ASP.NET Core 7.0 。我將我的出版物托管為Windows 服務。作為基礎，我使用Microsoft 的天氣預報演示應用程序。我對此進行了擴展，以便我可以列出所有本地 Windows 打印機並通過另 ...

使用 Swashbuckle 生成 Swagger 文檔時如何將泛型替換為具體類型？

[英]How to replace generic type to concrete type when generating Swagger documentation with Swashbuckle?

我的動作裝飾有：我需要將生成的響應更改為不同的類型。所以我添加了一個操作過濾器：但是生成 swagger json 時通用類型沒有被替換。我在這里缺少什么？ ...

Swagger 被具有不同 URL 的第二個 HttpPost 端點混淆

[英]Swagger confused by second HttpPost endpoint with different URL

我有以下 API 端點。這很好用。但我需要添加一個返回額外數據的版本，但我想在不破壞現有 API 的情況下進行。所以我在 URL 中添加了第二個帶有“ex”段的。這似乎也可以正常工作。然而，swagger 似乎對此感到困惑。有沒有人在這里看到問題，或者我該如何解決？如果我嘗試直接導航 ...

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

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

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

Swashbuckle 通過 .NET 應用程序中的 XML 評論使用格式標識符

[英]Swashbuckle use format identifier via XML comment in .NET application

我正在嘗試獲取在其主頁上說明的 Swagger UI 上打印的格式標識符。在自動生成的 json 文件中，它應該如下例所示：我想實現的方法是通過 883812976388 評論在我看來 model class。這適用於example ， summary等標簽，但沒有format標簽。對於 s ...

當我嘗試在 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 服務器，我運行了服務器並且它工作正常，問題出在我的頁面上我有幾個端點當我想嘗試端點時我 ...

為管道工提供 Swagger 中 PUT 的示例正文

[英]Provide example body for PUT in Swagger for Plumber

賞金將在 2 天后到期。此問題的答案有資格獲得+50聲望賞金。 fifthace想讓更多人關注這個問題。考慮以下使用 Plumber (R API) 的 PUT 請求示例：從 Swagger 測試這個例子效果很好：兩個打印語句表明body和req$body$body的值相同。但是，從 ...

如何注釋頁面<foo>用於生成正確的響應</foo>

[英]How to annotate Page<Foo> for generate correct response

RestController 返回響應我這樣注釋但我需要生成頁面而不是數組。有什么辦法可以做到這一點如果應該是這樣的如果我刪除注釋，它將生成正確的模式但沒有內容類型 ...

為 R 水管工在 Swagger 中添加帶有默認值的任意 http 標頭

[英]Adding arbitrary http headers with defaults in Swagger for R Plumber

賞金將在 2 天后到期。此問題的答案有資格獲得+50聲望賞金。 fifthace正在尋找規范的答案。我已將不記名令牌授權添加到我的 Swagger（使用 Plumber 創建），使用此處的解決方案。現在我想添加作為請求一部分的任意標頭。我的水管工部署由 React 儀表板使用，其中解析r ...

在 OpenAPI 3.1.0 中枚舉恰好 2 個（略有不同）對象的數組？

[英]Enumerating an array of exactly 2 (slightly different) objects in OpenAPI 3.1.0?

我需要記錄一個 REST 端點，它采用以下請求正文： variables數組必須恰好包含 2 個對象：一個具有所需name groupGuid和typeConstraint string ，另一個具有所需的name addMembership和typeConstraint boolean 。 ...

獲取實際的 Query() 值而不是解析值

[英]Get actual Query() value instead of parsed one

我在 controller 中有一個方法可以檢索多條記錄以及分頁和過濾。 @Query('isCorrect') isCorrect?: boolean | null我有問題 @Query('isCorrect') isCorrect?: boolean | null 。如果我通過 Postma ...

在 Spring Boot with springdoc-openapi-starter-webmvc-ui:2.0.2 中訪問 /v3/api-docs 時如何修復 http 500 錯誤？

[英]How to fix http 500 error when accessing /v3/api-docs in Spring Boot with springdoc-openapi-starter-webmvc-ui:2.0.2?

我正在嘗試在我的小 Spring Boot 項目中使用 swagger 和 springdoc。我不知道為什么，但每次我嘗試訪問 http://localhost:8080/v3/api-docs 時，我都會收到內部服務器錯誤。這是我的堆棧跟蹤： https://pastebin.com/y2 ...