AN @analysis_it
Showing posts older than #2341 · Back to latest
Forwarded from Business | System analyst
Получаю как-то документацию на внешнее API — для интеграции с платёжным сервисом. Открываю Swagger, всё красиво, эндпоинты на месте. Согласовываю интеграцию, передаю в разработку.
Через две недели разработчик приходит с вопросом: “А что возвращает API если платёж завис в статусе pending дольше часа?” И тут выясняется — в документации этого нет вообще. Ни слова.
Хорошая документация — редкость. Поэтому аналитик должен уметь читать её критически, а не просто принимать как есть.
Forwarded from Business | System analyst
И знаете что? Он был прав.
Эндпоинт: Создание заказа
Используется: мобильное приложение, личный кабинет
Контекст “кто вызывает” влияет на авторизацию и требования к нагрузке.
POST /api/v1/orders
Bearer token (JWT)
Authorization: Bearer {token}
{
"userId": 123, // integer, обязательное
"items": [...], // array, обязательное, min: 1
"comment": "..." // string, необязательное, max: 500
}HTTP 201 Created
{
"orderId": 789,
"status": "created",
"createdAt": "2026-06-17T10:00:00Z" // UTC, ISO 8601
}
error code. Договоритесь о едином формате ошибок на весь проект и зафиксируйте один раз.Таймаут: не более 2 секунд
Нагрузка: до 100 запросов в минуту
Idempotency-Key в заголовке. Само собой не появится.
Forwarded from Business | System analyst
POST /getUser
POST /createOrder
GET /deleteProduct?id=5
GET /users/{id}
POST /orders
DELETE /products/{id}
GET /products — список товаров
GET /products/{id} — конкретный товар
POST /products — создать товар
PATCH /products/{id} — обновить часть данных
DELETE /products/{id} — удалить товар
GET /users/{userId}/orders — все заказы пользователя
GET /users/{userId}/orders/{orderId} — конкретный заказ
POST /users/{userId}/orders — создать заказGET /orders/{id}{
"error": {
"code": "VALIDATION_ERROR",
"message": "Поле email обязательно",
"field": "email"
}
}{
"status": false,
"msg": "err"
}/api/v1/products
/api/v2/products
