OpenAPI / Swagger-ui:表单中自动生成的JSON忽略参数名

Question

编辑:在这里发帖后发现了这篇文章，请看下面的回答

我正在使用服务栈及其OpenApi插件。我不确定这是否是一个摇摆用户界面问题，服务栈或我的代码中的某些东西。

我有一个 POST 终结点，我希望在其中填充“客户”属性：

[Route("/api/customers/", "POST", Summary = "Creates a new customer")]
public class CreateCustomer : IReturn<CreateCustomerResponse>
{
    [ApiMember(Description = "The customer data", ParameterType = "body", IsRequired = true)]
    public Customer Customer { get; set; }
}

客户类具有许多属性，如“名字”等。

当我在swagger-ui中查看时，我可以看到“示例值”缺少名称“客户”,而JSON对象“客户”应该放在这个名称中:

如果我按下“尝试一下”按钮，我可以看到Swagger-ui直接发送“客户”对象，而没有指定它应该在“客户”内部(为了清楚起见，我删除了反斜杠，并从客户json中删除了属性):

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{  
   "PopulationRegistryNumber": "string",  
   "Firstname": "string",  
   "MiddleName": "string",  
   "Lastname": "string"
 }

我所期望的是：

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '
{ "Customer": 
   {
       "PopulationRegistryNumber": "string",
       "Firstname": "string",
       "MiddleName": "string",
       "Lastname": "string"
   }
}

现在，如果我删除服务堆栈 ApiMember 属性，则 Swagger-ui 具有正确的 JSON，但它在“客户”表单中添加了一个单独的字段，这是误导性的，不应该存在，因为它应该是正文的一部分。

“客户”字段是一个虚张声势的问题，还是一个服务堆栈问题，还是我遗漏了什么？

Answer 1

服务堆栈论坛上有一个帖子，其中讨论了这个确切的问题。

xplicit的最后一篇文章提供了一个解决方案，尽管我不清楚这些属性究竟是如何协同工作的。

部分解决了我的问题的解决方案是:

您可以使用 [ApiMember（排除在化学中=true）] 和 [Apimember（参数类型=“模型”）] 来排除您不希望在开放 API 定义中看到的属性。例如

[Route("/workflow/{ProjectId}", "POST")]
[Api(BodyParameter = GenerateBodyParameter.Always, IsRequired = true)]
public class WorkflowPostRequest : IReturn<Workflow>
{
    [ApiMember(ParameterType = "path", ExcludeInSchema = true)]
    public string ProjectId { get; set; }

    [ApiMember(ParameterType = "model")]
    public Workflow Workflow { get; set; }
} 

将生成以下开放 API 定义：

论坛帖子在这里。

注意:

该类上的属性 [Api（正文参数 = 生成正文参数.始终，需要 = true）]，在我的情况下是不需要的，正确的 JSON 和外观无论如何都可以工作。

所以，基本上，你需要做的就是从参数类型=“身体”到参数类型=“模型”。

还要注意，path、query等中的变量必须使用< code>ExcludeInSchema手动排除，这很烦人，但也是可行的。