Swagger在ASP。核心3

Question

当从查询字符串提取的模型将字典作为其属性之一时，Swagger生成错误的URL。如何告诉Swagger更改URL中字典的格式或手动定义输入参数模式，而不自动生成？试图使用Swashbuck和NSwag。

控制器

public class RecordsController : ControllerBase
{
  [HttpGet]
  [Route("services/records")]
  public async Task<IActionResult> Records([FromQuery] QueryModel queryModel)
  {
    return null;
  }
}

输入模型-查询字符串

public class QueryModel 
{
  public int Page { get; set; }
  public int Count { get; set; }
  public Dictionary<Columns, string> Conditions { get; set; }
}

Swagger UI为查询模型的“条件”属性显示了这种格式

{
  "UserId": "string",
  "GroupId": "string",
  "RecordId": "string"
}

Swagger生成的URL-Open API v2-将不会绑定到“条件”

/services/records?Page=0&Count=5&Conditions={"UserId":"1"} 

Swagger生成的URL-Open API v3-将不会绑定到“条件”

/services/records?Page=0&Count=5&UserId=1 

自定义URL-按预期工作并使用{"UserId"，"1"}初始化“条件”

/services/records?Page=0&Count=5&Conditions[UserId]=1 

问题

如何强制Swagger呈现URL，如属性名称[Key]=Value类型字典的属性？

替代问题

这不是一个解决方案，但是如果我以这种方式为输入参数定义默认值，Swagger 将创建正确的 URL。

{
  "Conditions[UserId]": "1",
  "Conditions[GroupId]": "2"
}

URL现在是正确的，并且正确地绑定到模型

/services/records?Page=0&Count=5&Conditions[UserId]=1&Conditions[GroupId]=2 

有没有办法更改显示在Swagger字典输入类型的默认值？

Answer 1

您需要为查询定义设置查询样式深度对象

NSwag目前通过SwaggerParameterStyle支持这一点，您将为其设置值＜code＞deepObject

我也很好奇在没有NSwag的情况下如何做到这一点，所以我看了看https://editor.swagger.io/

在这里，您可以向它提供您的静态json swagger，如果您想查看创建相同设置的不同方式，它将为您生成一个服务器

字典的示例模型

[DataContract]
public partial class Dictionary : IEquatable<Dictionary>
{ 
    /// <summary>
    /// Gets or Sets Word
    /// </summary>
    [DataMember(Name="word")]
    public string Word { get; set; }

    /// <summary>
    /// Gets or Sets Define
    /// </summary>
    [DataMember(Name="define")]
    public string Define { get; set; }

样本控制器

    /// <summary>
    /// Get word definition
    /// </summary>
    /// <remarks>Get me the word definitions</remarks>
    /// <param name="dictionary">Status values that need to be considered for filter</param>
    /// <response code="200">successful operation</response>
    [HttpGet]
    [Route("/v2/book")]
    [ValidateModelState]
    [SwaggerOperation("BookGet")]
    public virtual IActionResult BookGet([FromQuery][Required()]Dictionary dictionary)

原始 Swagger 示例查询

/book:
  get:
    summary: Get word definition
    description: Get me the word definitions
    parameters:
    - name: dictionary
      in: query
      description: Status values that need to be considered for filter
      required: true
      style: deepObject
      schema:
        type: object
        properties:
          word: 
            type: string
          define:
            type: string

查看中的deepObject样式https://swagger.io/specification/