📒 3 вида параметров в REST API, где чаще всего путаются аналитики 📒

Мини-гайд про виды параметров HTTP (REST API) запросов, в которых чаще всего косячат новички:


👉 query-parameters — после ? в URL
фильтры, сортировки, пагинация, поисковые строки, api-key (если так принято).

Формат:

GET /products?name=milk&limit=10&offset=20&order=price,asc

Типичные проблемы:
• Отправляют бизнес-данные для создания/изменения в query вместо тела json.
• Дробят сортировку в несколько параметров, вместо одного аккуратного.
• Добавляют query в POST/PUT без причины.



👉 path-parameters — часть пути (эндпоинта)
Идентификатор конкретного ресурса или вложенного ресурса.

Формат:

GET /products/{productId} → GET /products/3a46b…

Можно внутри пути:

PATCH /products/{productId}/archive

Типичные проблемы:
• Отправляют ?productId=… в query, хотя это сущность, а не фильтр.



👉 body-parameters — тело запроса json
Сообщение, когда создаём/меняем данные.
Только для POST | PUT | PATCH.
Кроме json могут быть другие форматы.

Формат:

{
"name": "Яблоки Гала",
"shortName": "Гала",
"description": "Сладкие и хрустящие"
}

Типичные проблемы:
• Отправляют огромное количество параметров в GET, которые там не помещаются, и могут быть обрезаны сервером при определенных настройках безопасности.


В гайде:
✔️ название параметра и его определение
✔️ скрины из Postman
✔️ особенности
✔️ примеры


Изучайте, запоминайте и не путайтесь 🤝

#RestApiGA #FarmFreshGA

🤔 В чем отличие REST от RESTful API? 🤔

Вопросы “Что такое REST API?” или “Что такое RESTful API?” в разных вариациях и формулировках задают на технических собеседованиях системных аналитиков 👀

Чтобы уверенно отвечать на них и глубоко понимать значение REST API, необходимо знать этот набор определений:


1️⃣ API — программный интерфейс для обмена данными между приложениями (мобильное приложение - сервер, сайт - сервер и другие).


2️⃣ HTTP — это протокол, лежащий в основе любого обмена данными в Интернете, который определяет, как сообщения должны формироваться и передаваться между клиентами и серверами. Он работает как система запросов и ответов: клиент отправляет запрос на сервер, а сервер возвращает ответ.

HTTP включает в себя определенные методы (GET, POST, PUT, DELETE и другие) и коды состояния (HTTP-200, HTTP-201 и другие), которые служат для управления взаимодействием и сообщают о результатах этих взаимодействий.


3️⃣ REST (Representational State Transfer) — это архитектурный стиль проектирования программного обеспечения для создания веб-сервисов (сервер-приложений). Это набор правил и принципов, по которым разрабатываются веб-сервисы.

REST предполагает, что данные или состояние программы можно представить в виде ресурсов (например, текстовых файлов, изображений, сервисов), и эти ресурсы можно адресовать через URL (веб-адреса).

Важным принципом REST является то, что с ресурсами можно выполнять стандартные операции через HTTP-методы, такие как GET, POST, PUT, DELETE и т.д.


4️⃣ REST API — программный интерфейс приложений (API), который позволяет взаимодействовать с веб-сервисами (сервер-приложениями) с использованием принципов REST. Это означает, что API позволяет обмениваться данными через стандартные HTTP-запросы (GET, POST, PUT, DELETE и т.д.) и может возвращать данные в формате, удобном для клиента (чаще всего в JSON или XML).


5️⃣ RESTful API — это термин, который подчеркивает строгое следование принципам REST. То есть, когда мы говорим, что API является "RESTful", мы хотим сказать, что он полностью соответствует архитектурным стилям и ограничениям, определенным в идеале REST. Это подразумевает, что API не только использует HTTP-методы и работает через URL, но и строго следует всем рекомендациям и лучшим практикам REST.

👉 По сути, RESTful API — это более точное или строгое использование термина REST API. В обоих случаях речь идет о системах, которые позволяют взаимодействовать с веб-сервисами в соответствии с архитектурой REST, но использование слова "RESTful" подразумевает более глубокое соблюдение принципов REST.

👉 В повседневной разработке эти различия зачастую стираются, и термины используются как синонимы.


Желаю вам успешных технических собеседований 😉

#RestApiGA