В этой статье мы увидим, что такое REST, какие поддерживаются методы HTTP и статус ответа. и как создавать конечные точки REST.
ОТДЫХ
REST (reпредставление state ttransfer) — это архитектурный стиль, определяющий, как клиент и сервер могут взаимодействовать по сети. он содержит некоторые рекомендации по использованию при разработке API.
Основной дизайн с REST — без сохранения состояния, что означает, что сервер не будет поддерживать какое-либо состояние между запросами от клиентов. клиент отправит запрос на сервер, а сервер выполнит некоторую работу на основе запроса и вернет данные. этот запрос полностью независим от прошлых или будущих запросов.
Давайте посмотрим, какие общие методы HTTP поддерживает REST.
HTTP-методы
- GET → вернуть существующий ресурс с сервера
- POST → Создать новый ресурс на сервере
- PUT → обновить существующий ресурс на сервере.
- ИСПРАВЛЕНИЕ → Частично обновить ресурс на сервере.
- УДАЛИТЬ → Удалить существующий ресурс на сервере.
выше приведены наиболее часто используемые методы HTTP.
При работе с REST API код состояния сообщает нам о типе ответа, возвращаемого сервером. Давайте посмотрим, каковы часто встречающиеся статусы ответов.
Коды состояния HTTP
200 → OK → Запрос выполнен успешно.
201 → Создано → Созданы новые ресурсы
202 → Принято → Запрос принят, но на сервере еще нет изменений
204 → Нет содержимого → Успешный запрос, но содержимое не возвращено
400 → Неверный запрос → Запрос имеет неверный формат
401 → Неавторизовано → Клиент не авторизован для выполнения этого действия
404 → Не найдено → Ресурс не найден на сервере
415 → Неподдерживаемый тип носителя → Запрошенный тип данных не поддерживается сервером
422 → Необрабатываемый объект → Запросы содержат недопустимые или отсутствующие данные
500 → Внутренняя ошибка сервера → На сервере произошли некоторые ошибки
Все коды состояния представляют категорию ответов.
Категории кодов состояния HTTP
2xx → Успешные действия
3xx → Перенаправление
4xx → Ошибки клиента
5xx → Ошибки сервера
В API REST нам также необходимо создать конечные точки, которые будут вызываться клиентом. давайте посмотрим, как создать эти конечные точки.
Предположим, у нас есть User
ресурс на сервере. Таким образом, конечные точки будут сформированы следующим образом
GET → /users → получить всех пользователей
GET → /users/‹userId› → получить одного пользователя
POST → /users → Создать нового пользователя
PUT → /users/‹userId› → Обновить пользователя
ИСПРАВЛЕНИЕ → /users/‹userId› → Частично обновить пользователя
УДАЛИТЬ → /users/‹userId› → Удалить пользователя
Надеюсь, вы получили представление об архитектуре REST.
Ваше здоровье!
Дополнительные материалы на PlainEnglish.io. Подпишитесь на нашу бесплатную еженедельную рассылку новостей. Подпишитесь на нас в Twitter и LinkedIn. Посетите наш Community Discord и присоединитесь к нашему Коллективу талантов.