Структура конечных точек отдыха

Предположим, у меня есть требования:

  • Зарегистрируйтесь по электронной почте
  • Зарегистрируйтесь через социальную сеть
  • Войти по электронной почте
  • Вход через социальную сеть
  • Выйти
  • Получить мой профиль
  • Редактировать мой профиль
  • Получить профиль пользователя
  • Список моих друзей
  • Список друзей пользователей
  • Пригласить друзей из социальной сети
  • Добавить продукт
  • Изменить продукт
  • Поиск продукта
  • Список моих продуктов
  • Список некоторых пользовательских продуктов

Какой должна быть структура REST API конечных точек?


rest api-design restful-url httpverbs restful-architecture
person Sodiaan    schedule 25.11.2016    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Всегда спрашивайте себя:

Каковы мои ресурсы?

  • Зарегистрируйтесь по электронной почте POST /api/registration
  • Зарегистрируйтесь в социальной сети POST /api/providerRegistration
  • Получить профиль пользователя GET /api/user?userId={userId}
  • Список моих друзей GET /api/friends
  • Список друзей пользователей GET /api/friends?userId={userId}
  • Добавить продукт POST /api/product
  • Изменить продукт PUT/PATCH /api/product/{productId}
  • Поиск продуктов GET /api/products?status={status}
  • Список моих продуктов GET /api/products?userId={userId}

И так далее - вы поняли суть. Обратите внимание, что путь (ресурс REST) ​​— это существительное (product), а не глагол (search).

person Alexandru Marculescu    schedule 29.11.2016