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

Question

我正在嘗試獲取在其主頁上說明的 Swagger UI 上打印的格式標識符。 在自動生成的 json 文件中，它應該如下例所示：

我想實現的方法是通過 883812976388 評論在我看來 model class。這適用於example ， summary等標簽，但沒有format標簽。 對於 state，我們在 API 中等待的字符串必須采用特定格式，這對我來說很重要。

此處提出了類似的問題，但格式標識符還沒有答案。

我怎樣才能做到這一點？ 使用的版本：.NET 7 和 Swashbuckle v 6.4.0。

我的觀點 model 看起來像這樣：

public class MeasurementViewModel {
    /// <example>20.01.2003</example>
    /// <format>dd.mm.yyyy</format>  <-- this is what I would expect but doesn't have any effect
    [JsonProperty("patient_birthdate")] public string? PatientDateOfBirth { get; set; }
}

Answer 1

由於那個答案找到了解決方案。

我通過 NuGet 添加了額外的 package“Swashbuckle.AspNetCore.Annotations”，並在我配置 Swagger 代的 Startup.cs 中啟用了注釋：

services.AddSwaggerGen(c =>
    ...
    c.EnableAnnotations();
}

在我的 ViewModel 中，我現在可以使用以下注釋：

/// <example>20.01.2002</example>
[JsonProperty("patient_birthdate"), SwaggerSchema(Format = "dd.mm.yyyy")] public string? PatientDateOfBirth { get; set; }

.. 這會產生一個漂亮的文檔：