Прямо сейчас у меня есть конечная точка, которая отправляет файл пользователю (json, csv, excel или pdf).

Мой вопрос здесь заключается в том, какой тип маршрута я должен использовать для его обслуживания, переменных пути или параметров запроса (с учетом передового опыта и для понимания разработчика):

BaseURl/API/v1/ресурс/xlsx

Или

BaseURl/api/v1/resource?format=xlsx

Заранее спасибо.

0
luis carlos cruz castillo 4 Фев 2022 в 00:59
Вопросы, ответы на которые основаны на мнениях, явно не относятся к теме сайта, определенной в справочном центре.
 – 
esqew
4 Фев 2022 в 01:30

2 ответа

Лучше всего использовать заголовки для HTTP, чтобы показать, какой формат может понять клиент. Вы должны использовать маршрут get и включить заголовок Accept для формата.

Header key: Accept

Header Value: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept

HTML Input = "file" Принять тип файла атрибутов (CSV)

0
Dijkgraaf 4 Фев 2022 в 01:28
1
Мой вопрос не о заголовке, а о конечной точке, переменной пути или параметрах запроса.
 – 
luis carlos cruz castillo
4 Фев 2022 в 01:41
Луис не говорит ни о заголовке ответа, ни даже об информации, возвращаемой на конечной точке, насколько я понимаю, он запрашивает лучшие практики для разрешения конечной точки.
 – 
Miguel V
4 Фев 2022 в 01:43
Он не говорит о заголовках ответа, он говорит о заголовках клиента. Таким образом, вместо того, чтобы указывать тип в URL-адресе, клиент делает это в заголовках.
 – 
Dijkgraaf
4 Фев 2022 в 02:35

Если вы соблюдаете правила производства схема http URI, любые выбранные вами правила правописания подходят.

Выбор вариантов написания, соответствующих возможностям шаблонов URI, упростит создание/деконструкцию ресурса. идентификаторы в «общем пространстве URI», что часто удобно как для клиентов, так и для серверов.

Использование сегментов пути против запроса - это чисто компромисс. Использование пар ключ-значение application/x-www-form-urlencoded в части запроса означает, что вы можете реализовать свой шаблон URI в виде HTML-формы. Использование сегментов пути означает, что вы можете использовать сегменты точек для описания других идентификаторов в общем пространстве URI.

Если вас не волнует ни один из них, все сводится к тому, какое написание вам больше всего нравится в журнале доступа, или в ваших документах, или в истории браузера, или когда вы вставляете их в сообщение электронной почты, или... ..

0
VoiceOfUnreason 4 Фев 2022 в 02:28