Лучшие практики разработки REST API: 20 советов
1. Используйте kebab-case для URL
2. Используйте camelCase для параметров
3. Используйте множественное число для коллекций
4. URL должен начинаться с коллекции и заканчиваться идентификатором
5. Не используйте глаголы в URL ресурсов
6. Пользуйтесь глаголами в URL операций
7. Используйте camelCase для JSON свойств
8. Состояние
9. Используйте инструменты для разработки REST API
10. Используйте простой порядковый номер для версий
11. Указывайте количество ресурсов в ответе на запрос
12. Используйте параметры limit и offset
13. Используйте параметр fields
14. Не передавайте аутентификационные токены в URL
15. Проверяйте Content-Type
16. Используйте HTTP методы для CRUD операций
17. URL должен отражать структуру вложенных ресурсов
18. CORS. Используйте заголовки для совместного использования ресурсов
19. Обязательно используйте HTTPS (TLS-encrypted) для всех конечных точек, ресурсов и сервисов.
20. Ошибки. Возвращайте правильные коды ошибок
Подробнее по ссылке:
Recommended Posts
Спецификация JSON:API 1.0 на русском языке
28.01.2022
Что такое RPC и REST
19.02.2019
Что такое API
18.02.2019