Swashbuckle、Swagger 模式和格式注释或 XML 评论

Question

我正在尝试在我的 Swagger 文档中添加格式 and/or 模式关键字。我正在使用 Swashbuckle 和 currenlty 我正在使用 XML 评论来为我的不同领域插入描述。例如：控制器：

/// <summary>
/// Shows a list with states
/// </summary>
/// <param name="id">The state ID</param>
/// <returns>Offers the state</returns>
[HttpGet("id", Name = "Get")]
public async Task<ActionResult<State>> GetState(string id)
{
State result = GetState(id);
return Ok(result);
}

我希望 swagger 文档显示带有正则表达式的模式关键字：

'^[{(]?[0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$'

是否可以在使用 XML 评论或注释时添加此文档。我想对 format 关键字提出同样的要求。例如： 'format: date-time'

是否可以使用 XML 带有 Swashbuckle 的注释或注释来自动生成 Swagger 文档，或者这是否需要静态 swagger 文件？

Answer 1

我刚刚尝试将正则表达式添加到我的一个使用 swagger 的项目中，它运行良好

/// <param name="customerId">^[{(]?[0-9A-F]{8}[-]?(?:[0-9A-F]{4}[-]?){3}[0-9A-F]{12}[)}]?$</param>

Answer 2

项目中有一个如何将其用于模型的示例： https://github.com/domaindrivendev/Swashbuckle/blob/5489aca0d2dd7946f5569341f621f581720d4634/Swashbuckle.Dummy.Core/Controllers/MetadataAnnotatedTypesController.cs#L21

public class PaymentMetadata
{
    [Required]
    public decimal Amount { get; set; }

    [Required, RegularExpression("^[3-6]?\d{12,15}$")]
    public string CardNumber { get; set; }

    [Required, Range(1, 12)]
    public int ExpMonth { get; set; }

    [Required, Range(14, 99)]
    public int ExpYear { get; set; }

    [StringLength(500, MinimumLength = 10)]
    public string Note { get; set; }
}

对于像你这样的原语，我不确定它是否得到完全支持，你可以尝试类似的东西：

public async Task<ActionResult<State>> GetState([RegularExpression("PATTERN")]string id)

如果这不起作用，您可以使用 IDocumentFilter

注入它

Swashbuckle、Swagger 模式和格式注释或 XML 评论

Swashbuckle, Swagger Pattern and Format annotation or XML comment

json

asp.net-web-api

swagger-ui

swagger-2.0

swashbuckle