Определите соответствующие URI и ресурсы в архитектуре REST

Question

Я относительно новичок в архитектуре REST, у меня есть вопрос о том, как мне реализовать мой RESTful API для моего проекта.

Какие URI и ресурсы будут подходящими для:

1. Вход и выход?

Что я думаю: POST or DELETE /api/users/auth или POST or DELETE /api/users/login?

2. Установить, удалить или получить аватар пользователя?

Что я думаю: POST or DELETE or GET /api/users/{id}/avatar. это правильно?

3. Проверить по отправленному коду?

Что я думаю: POST /api/users/{id}/verification. это правильно?

4. Изменить одно или несколько конкретных свойств пользователя? (например, изменение адреса электронной почты или имени пользователя)

Что я думаю: PACTH /api/users/{id} или PUT /api/users/{id}/email. это правильно?

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

Answer 1

1. Вход и выход?

Для веб-API вы должны реализовать OAuth-авторизацию , а затем использовать

POST /oauth для получения токена

2. Установить, удалить или получить аватар пользователя?

Для этого нет особых правил, но люди ДОЛЖНЫ иметь возможность легко читать и создавать URL-адреса. Так что, думаю, все будет хорошо

POST or DELETE or GET /api/users/{id}/avatar

3. Проверить по отправленному коду?

Вам решать.

4. Изменить одно или несколько конкретных свойств пользователя? (например, изменение адреса электронной почты или имени пользователя)

Здесь я предлагаю использовать PACTH /api/users/{id} с json body для частичного обновления или PUT /api/users/{id} для полного обновления пользователя. Посмотрите на этот пакет

Вы можете прочитать Рекомендации Microsoft REST API для более подробной информации.