Внешние ключи в Web API 2 - Лучшие практики?

Question

В основном я пишу API с использованием Web API 2 и Entity Framework на бэкэнд.

То, что я не уверен в том, что делать с иностранными ключами на моих моделях.

Скажите, что я получил людей собственности с внешним ключом к порядка собственности.

Иногда клиенту нужна собственность человека, иногда это не так. Как мне это сделать?

Должен ли я создать 2 метода: /апи/чел/1 < - возвращает человека без того /апи/personwithorder/1 < - возвращает лицо с заказом

Кажется ужасно много методов в мое мнение.

Я знаю, что существует атрибут queryable, который предоставляет поддержку клиенту для использования аргумента $ extend для включения свойств по своему желанию. Однако я бы предпочел не использовать запрашиваемый атрибут, если я могу его избежать.

Каковы ваши предложения?

Answer 1

Сверху моей головы, вот несколько вариантов.

Вариант 1

Несколько методов в API

public Person GetPerson() { ... } 
public Person GetPersonWithOrders() { ... } 

Вариант 2

Pass флаг методу:

public Person GetPerson(bool getOrders) { ... } 

Вариант 3

Вы можете использовать OData, чтобы позволить вызывающему абоненту запрашивать данные.

Answer 2

Чтобы расширить опции DavidG 3 от использования OData, вот как вы бы это сделать:

1. Install-package Microsoft.AspNet.WebApi.OData

2. Создать PeopleController наследующий ODataController

3. Настройка веб- API-модель OData:

   modelBuilder.EntitySet<Person>("People");

4. Определите метод Get как возвращение к IQueryable<Person>

5. В коде вызова, добавьте пункт expand к URL, чтобы указать дочерний объект вы хотели бы выставить, как это: /api/People(1)?$expand=Orders

Немного больше об этом регистрирует маршрут OData, но это стандартная конфигурация, которую вы можете найти в любом sample project.

OData действительно очень гибкий и заботится о тоннах вопросов о том, как вы должны создавать свои URL-адреса.