REST API URL design Лучшие практики

Question

Я разрабатываю REST API для системы, в которой много параметров настройки. Все эти параметры должны быть в состоянии изменить. Эти параметры сгруппированы по категориям и имеют уникальные имена. Параметры имеют разные единицы измерения, и они бывают разных типов (логическое, число или объект с несколькими свойствами). Например, у меня есть параметры «поток» и «порог», которые относятся к категории «процесс», и один параметр «имя», который принадлежит категории «общие». Каков обычный способ определения URL? Это:

/process/flow

/process/threshold

/general/name 

Или лучше, чтобы каждый параметр имел уникальный номер (id). А без использования категорий URL можно просто определить следующим образом:

/param/{id}

Answer 1

Разработка REST API URL Лучшие практики

REST не заботится о дизайне URL. До тех пор, пока используемые вами идентификаторы соответствуют производственным правилам, описанным в RF C 3986 , вы можете использовать любое написание, которое вам нравится.

/general/name
/param/12345
/3eaa7b95-c46b-4290-9614-546dc17c1f2d

Это все прекрасный . С точки зрения компонента общего назначения (например, веб-браузера или кэша), URI является непрозрачным - мы никогда не "анализируем" URI для извлечения из него семантической c информации.

Это означает, что сервер может встраивать в URI любую информацию, необходимую ему для идентификации ресурса - будь то токен, читаемый человеком, или суррогатный ключ, или ха sh ... это все хорошо .