Многие ко многим ресурсам картирование успокоительный дизайн API - PullRequest
Новая
       83

Многие ко многим ресурсам картирование успокоительный дизайн API

0 голосов
/ 14 февраля 2020

Здесь много других вопросов, нацеленных на ту же проблему many-to-many relationship url design for restful apis. У меня примерно то же самое, , но оно отличается от других .
. Я не мог найти лучшего подхода.

У меня есть locations ресурс и services resource` 

GET /services                           //it should give you all services
GET /locations                          //it should give you all locations
GET /locations/:id/services             //it should give you all services offered by a location


У меня проблема в том, что мне нужно спроектировать маршрут, который
Все местоположения вместе с предлагаемыми ими услугами

Я прошел через пост на reddit , который предлагает.
GET /locations?include=services

Я тоже прошел через до c. Это предлагает.
GET /locations-services

Я уверен, что я не первый, кто испытывает такое замешательство.
Пожалуйста, помогите, и, если возможно, поделитесь некоторыми ресурсами, которые я могу go до очистить мои сомнения.

1 Ответ

1 голос
/ 14 февраля 2020

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

Но 

/a1dadfcb-8fc6-4456-b05e-a0b91575e0ef

- вполне удовлетворительный URI. 

/locations?include=services
/locations?services
/locations-services
/locations/services
/service-directory

Это все отлично . Компонентам общего назначения все равно, если вы используете орфографию, соответствующую правилам производства, определенным RF C 3986

...