Дизайн REST API (или “контракт REST API”) — это договоренность между разработчиками клиентов (Frontend или другие сервера) и разработчиками сервера (Backend) о том, как будут работать методы REST API.

Он включает в себя полное описание API-методов:

✔️ структуры запроса:
+ Метод (GET, POST, …)
+ URL ресурса
+ Заголовки (headers)
+ Тело запроса (body) в формате JSON (или другом)

✔️ и структуры ответа:
+ Статус-код HTTP
+ Заголовки ответа (headers).
+ Тело ответа в формате JSON (или другом).

Его создают Системные аналитики совместно с Backend-разработчиками.


Что важно знать о влиянии разных частей системы на дизайн REST API методов смотрите в картинках.
#hardGetAnalyst