Какова наилучшая практика для URL-адресов REST при запросе зарезервирована или существует

Question

У меня есть API для системы бронирования. Две основные объекты: - Бронирование и недвижимости

public class Booking 
{ 
    public DateTime CheckInDate {get; set;} 
    public DateTime CheckOutDate {get; set;} 
    public int PropertyId {get; set;} 
} 

public class Property 
{ 
    public int Id {get; set;} 
} 

мне нужно знать, если определенное свойство доступно в течение периода или нет.

Действительно ли этот URL-адрес действителен для этого запроса?

/апи/Бронирование/availableProperty? PropertyID = 1 & CheckInDate = 1/1/2017 & CheckOutDate = 1/2/2017

Справедливо ли возвращать логическое значение в результате URL isPropertyReserved ?

/апи/Бронирование/isPropertyReserved? PropertyID = 1 & CheckInDate = 1/1/2017 & CheckOutDate = 1/2/2017

Answer 1

В REST, вместо того, чтобы пытаться определить многочисленные discoordinated конец API - точки для каждого отдельного случая, вы должны сосредоточиться на определении collections and resources.

В модели, Property представляет собой ресурс, который имеет идентификатор и может быть забронированы от check-in до check-out даты, так что кажется естественным ввести properties коллекции (но, в зависимости от ваших требований вы можете выбрать ввести bookings коллекцию):

запрос (получить все свойства)

GET: api/properties 

Response

[ 
    { 
    "url": "api/properties/1", 
    "bookings":[ 
     { 
     "url": "api/properties/1/bookings", 
     "checkInDate": "2017-01-01", 
     "checkOutDate": "2017-02-01" 
     } 
    ] 
    }, 
    { 
    "url": "api/properties/2", 
    "bookings": [] 
    } 
] 

Запрос (получить собственность с идентификатором 1)

GET: api/properties/1 

Response

{ 
    "url": "api/properties/1", 
    "bookings":[ 
    { 
     "url": "api/properties/1/bookings", 
     "checkInDate": "2017-01-01", 
     "checkOutDate": "2017-02-01" 
    } 
    ] 
} 

Запрос (получить все заказы на недвижимость с идентификатором 1)

GET: api/properties/1/bookings 

Response

[ 
    { 
    "url": "api/properties/1/bookings", 
    "checkInDate": "2017-01-01", 
    "checkOutDate": "2017-02-01" 
    } 
] 

Запрос (проверьте, есть ли заказ на определенную дату)

GET: api/properties/1/bookings/2017-01-15 

Ответ (информация о бронировании, если найдена; пустой результат, если нет)

{ 
    "url": "api/properties/1/bookings/2017-01-15", 
    "checkInDate": "2017-01-01", 
    "checkOutDate": "2017-02-01" 
}