Некоторые типичные ошибки, которые допускают разработчики при обработке запросов в RESTful API:
- API, завязанное на внутренней структуре. 1 API отражает внутреннюю логику, заставляя клиентов разбираться в базе данных. 1 API должен быть понятным пользователю, а не разработчику системы. 1
- Неправильные URL и HTTP-методы. 1 Некоторые API добавляют глаголы в пути или усложняют структуру. 1 Также не стоит делать глубокую вложенность. 1
- Игнорирование обработки ошибок. 1 Чёткие коды ошибок экономят время и нервы разработчиков. 1
- Отсутствие версионирования. 1 Если API обновляется без версионирования, старые клиенты ломаются. 1 Важно не удалять старые версии без предупреждения. 1
- Слишком много данных в ответах. 1 API отдаёт всю информацию, даже если она не нужна. 1 Правильнее будет позволять клиенту выбирать поля и делить данные на отдельные запросы. 1
- Проблемы с безопасностью. 1 Одна из самых частых ошибок с точки зрения безопасности — передача токенов в URL. 1 Также начинающие разработчики реализуют API, в которых отсутствуют ограничения запросов или используется HTTP вместо HTTPS. 1
- Плохая документация. 1 Наиболее частые проблемы по этой части: нет примеров кода, непонятно, как авторизоваться, ошибки не объясняются. 1
- Частичные обновления данных. 4 Использование PUT для обновления всего ресурса может привести к конфликтам, поскольку оно заменяет ресурс и может привести к потере данных, если несколько клиентов обновляются одновременно. 4