簡體   English   中英

Swagger/Swashbuckle 示例僅限於一個示例 pr 請求 object?

[英]Swagger/Swashbuckle Example limited to one example pr request object?

我一直在努力使用 Swashbuckle 制作 swagger 請求示例,因為我有幾個端點使用相同的請求 model。 我做了多個示例,將正確的示例應用於每個端點,但只有一個示例將應用於所有端點,這讓我很困惑。 然后我在 github ( https://github.com/mattfrear/Swashbuckle.Examples ) 上閱讀了這篇文章:

對於請求,在 Swagger 2.0 規范中,在所有 API 端點中定義的每個請求 object 只有一個模式。 因此,如果您在多個 API 端點中使用相同的請求 object,即在多個 controller 操作上,如下所示:

public async Task<IHttpActionResult> DeliveryOptionsForAddress(DeliveryOptionsSearchModel search)
...
// maybe in some other controller, e.g. Search.cs
public async Task<IHttpActionResult> Search(DeliveryOptionsSearchModel search)

該 DeliveryOptionsSearchModel object 在整個 Swagger 文檔中僅定義一次,並且只能定義一個請求示例。

所以我的問題是,有沒有辦法解決這個問題? 我看到有人使用了 Example 標簽,但它沒有顯示任何內容。 備注標簽確實有效,但我寧願有一個適當的例子,如果可能的話可以直接使用。

好的,我聯系了創建者 Matt Frear,他向我解釋說,如果我想要同一類型的多個請求示例,我必須從 Swashbuckle.Examples 轉移到 Swashbuckle.AspNetCore.Filters。 不幸的是,我當前的項目正在運行框架 4.6,因此我無法對其進行測試,但如果您的項目正在運行核心,它應該足夠簡單。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM