C# ServiceStack 특성 및 Swagger UI - 복잡한 개체 목록

Question

복잡한 개체의 정의를 나열하기 위해 Swagger-UI 용 C#에서 주석을 사용하는 적절한 방법은 무엇입니까? 나는 그런 식으로 사용하는 경우

[ApiMember(Name = "Foo", Description = "Some description", 
DataType = "List<Foo>", IsRequired = true)]  
public List<Foo> Foo {get; set;} 

그래서, 자신감-UI 이것이 List하지만 Foo에 연결하거나 아무것도하지 않는 것이 문서에 표시 만합니다 : 우리는이 같은이있는 경우 예를 들어

, .

즉, model \ schema에 제대로 표시되었지만 필드 정의에 나열되지 않은 경우 작동하는 방식 또는 목록에서 예상되는 정확한 데이터 구조를 가리 키도록 변경할 수 있습니다. 정렬?

편집 다음은 전체 DTO 샘플입니다 :

[Route("/warranties", "POST", Summary = "POST New Warrantty", Notes = "Create new warranty into our system")] 
public class CreateWarrantyRequest : IReturn<ApiResponse> 
{ 
    [ApiMember(Name = "CoverageId", Description = "Coverage Id", DataType = "int", IsRequired = true)] 
    public string CoverageId { get; set; } 

    [ApiMember(Name = "WarrantyProducts", Description = "Warranty Products", DataType = "List<WarrantyProduct>", IsRequired = true)] 
    public List<WarrantyProduct> WarrantyProducts { get; set; } 
} 

public class WarrantyProduct 
{ 
    [ApiMember(Name = "Manufacturer", Description = "Manufacturer Name", DataType = "string", IsRequired = true)] 
    public string Manufacturer { get; set; } 
    [ApiMember(Name = "ProductType ", Description = "Product Type", DataType = "ProductType", IsRequired = true)] 
    public ProductType ProductType { get; set; } 
    [ApiMember(Name = "SerialNumber", Description = "Serial Number", DataType = "string", IsRequired = true)] 
    public string SerialNumber { get; set; } 
    [ApiMember(Name = "PurchasePrice", Description = "Purchase Price", DataType = "decimal", IsRequired = true)] 
    public decimal PurchasePrice { get; set; }  
} 

그리고 이것은 SwaggerFeature으로 모습입니다 :

을 그리고 이것은 OpenApiFeature으로 모습입니다 :

Answer 1

데이터 유형은 a known type을 지정합니다. List<T> 같은 복잡한 유형의 정의는 그 itemsreferencing the Complex Type schema, 예컨대와 함께 array 유형을 지정하여 수행됩니다

{ 
    "description": "A complex object array response", 
    "schema": { 
    "type": "array", 
    "items": { 
     "$ref": "#/definitions/VeryComplexType" 
    } 
    } 
} 

이 ServiceStack는 데이터 유형을 지정하지 않고 자동으로 무엇이며, 복합 유형을 정의 할 수 없습니다 [ApiMember]를 사용하여.