Дизайн REST API для возврата логических значений
Я разрабатываю API для отдыха, который будет принимать дату и возвращаться, если дата является праздником или не в логическом формате. Каким должен быть шаблон URL для этого?
GET <domainname>/holidays?date=<mmddyyy>
Должно ли это быть что-то вроде этого или есть лучший способ создать URL-адрес?
Ответы 1
Should it be something like this or is there a better way to design the url?
Машинам все равно — URI — это просто идентификатор. Подобно именам переменных, мы даем им удобочитаемое написание для нашей собственной выгоды.
То есть, если бы вы использовали такой идентификатор, как
/a7c63fe6-ca28-4f21-9421-c9ca3df75658?yyyymmdd
Тогда все должно еще работать.
Использование пар ключ/значение application/x-www-form-urlencoded является хорошим выбором, потому что процессоры HTML-форм понимают, как создавать эти URI, и поэтому их можно использовать/тестировать через веб-страницы.
?date=<YYYY-MM-DD>
Но другие договоренности не являются неправильными; у нас просто разные компромиссы.
/holidays/date/<mmddyyy>
Это написание позволяет вам делать интересные вещи с относительными ссылками.
Предполагая, что вы предполагаете, что клиент создает эти URI, вам понадобится что-то, что согласуется со спецификацией Шаблон URI.
Рэндал Манро настоятельно рекомендует вам следует поощрять написание даты в соответствии со стандартом ISO-8601.