URL REST для вложенных ресурсов - PullRequest
0 голосов
/ 26 июня 2018

Как правильно создать путь REST? Скажем, у меня есть REST-ресурс, как,

base_url/api/projects/{projId}/sprints/{sprintId}/.....etc

У меня более 5 таких параметров пути в URL ресурса. Правильно ли иметь так много параметров пути, или мы должны сократить его до разных ресурсов, например,

base_url/api/projects/{projId}
base_url/api/sprints/{sprintId}
...etc

Условие здесь: спринт не может существовать без проекта и так далее. Если нам нужно сократить ресурсы по разным путям, существуют ли какие-либо стандарты, на каких условиях мы можем их сократить?

1 Ответ

0 голосов
/ 26 июня 2018

REST не заботится о дизайне URI. Это заблуждение.

Читаемость URI желательна , но не обязательна в архитектурном стиле REST.


Как определено в RFC 3986 , синтаксис URI организован иерархически, с перечислением компонентов в порядке убывания значимости слева направо, разделенных /. Если sprint не может существовать без проекта , вы можете использовать следующее для выражения такой иерархии :

/api/projects/{project-id}/sprints/{sprint-id}

Однако, если URI становится слишком длинным и у вас есть много параметров для передачи, нет проблем с его разделением:

/api/projects/{project-id}
/api/sprints/{sprint-id}
...