1. Автоматизация кэширования
Повторный запрос и реагирование на эти запросы потребляет ресурсы, и это становится признаком ошибочного дизайна. Чтобы решить эту проблему, вы должны хранить данные, извлеченные из API на сервере и служат позже оттуда. Тем не менее, есть времена, когда данные устареют и должны быть обновлены, в этом случае у нас есть некоторые решения для кэширования отрасли (Redis и Amazon ElasticCache), которые могут кэшировать данные даже после внесения изменений.
2. Документация API.
Всегда предоставляйте четкую и краткую документацию необходимо для любого API, становится сложнее использовать эту API позже без хорошей документации. Поэтому убедитесь, что ваша API имеет хорошую документацию, используя простые языки с обновлениями и новыми выпусками. Ваша документация API должна включать следующее:
Просто и легко читать язык. Реализация API на разных языках программирования.
3. Не возвращайте простой текст
Не нужно преодолеть json в архитектуре покоя, так как большинство APIS-APIS используют JSON в качестве формата данных. Но есть времена при возврате тела, содержащего json-форматуну, недостаточно.
Такой, как вы можете указать заголовок типа содержимого, установленный на приложение для значения/JSON.
4. 401 ВС 403.
Оба кода статуса имеют разные значения, и очень легко запутаться, связано ли это с аутентификацией или авторизацией. Для того, чтобы решить проблемы быстрее, вам нужно знать разницу. Если пользователь не предоставил данные аутентификации или они были недействительными, то это 401 несанкционировано. И если пользователь успешно аутентифицируется, но не предоставил разрешения для доступа к ресурсу, то это 403 запрещено.
Читать дальше по адресу: https://javascript.plainEnglish.io/8-best-practices-for-rest-api-design-3fd1b837b283.
Оригинал: “https://dev.to/mohit199thd/8-best-practices-for-rest-api-design-1d97”