Список Vs Деталь DTO - PullRequest
Новая
       10

Список Vs Деталь DTO

1 голос
/ 02 октября 2019

Я использую ServiceStack для создания моего первого API. В моем сервисе пользователь может вводить новые заказы и получать те, которые он уже выполнил. Каждый заказ имеет очень сложную структуру, состоящую из различных полей и списков объектов (некоторые из которых состоят из 10 или 100 наименований, другие состоят из тысяч записей, поэтому требуется подкачка страниц).

Вопросявляется: что и сколько данных для отправки клиенту.

Гипотетически, когда клиент запрашивает список последних выполненных заказов, я должен предоставить список заказов с несколькими полями.

Когда клиент вместо этого запрашивает деталь заказа, я мог бы дать ему больше информации.

В мире REST я видел 2 метода:

[просмотр] параметр

/ orders? View = list

/ orders? View = detail

, который может быть«list | detail», который предоставляет более краткую или более подробную версию запрошенного объекта.

[раскрыть] параметр

/ orders? expand = customer

/ orders? Expand = customer, address, phone, address

, что позволяет указывать, какие поля извлекать

Таким образом, запрашивает ли пользователь список объектов или сведения, которые он может указать, сколько информации он хочет получить.

Это решение принято Stripe.com, которое также предоставляет клиент ac #.

https://github.com/stripe/stripe-dotnet/blob/master/src/Stripe.net/Entities/ExpandableField.cs

Как эти решения могут быть реализованы с помощью ServiceStack и, в частности, стот факт, что один и тот же API-интерфейс может использоваться как через http, так и через ServiceStack.Client?

Может ли быть хорошей идеей создать два типа DTO? )

OrderDetailDTO (содержит все поля)

1 Ответ

1 голос
/ 02 октября 2019

То, что вы выберете, зависит от вашего варианта использования, обычно вы возвращаете сводную информацию при просмотре всех заказов: 

/orders

И полную информацию о заказе при просмотре одного заказа: 

/orders/1

Если вы хотите реализовать настройку ?expand, просто добавьте ее в качестве другого свойства в запрос DTO, а затем используйте ее, чтобы проверить, какую дополнительную информацию вы должны заполнить в Response DTO, например: 

[Route("/orders")]
public class QueryOrders : IReturn<QueryOrdersResponse>
{
    public string[] Expand { get; set; }
}

public object Any(QueryOrders request)
{
    var expand = new HashSet<string>(request.Expand ?? new string[0],
       StringComparer.OrdinalIgnoreCase);

    if (expand.Contains(nameof(Order.Customer)))
    {
       // populate Response DTO with additional info...
    }
}
...