Feedback Service Contract#23
Conversation
AxoRm
left a comment
There was a problem hiding this comment.
- Необходимо добавить вершонинг через переменную servers
- Организовать единые ответы ошибок через components/responses
- Поставить стандартные HTTP коды при успешном выполнении:
-
- Для создания ресурсов (POST) выдавать 201 Created и заголовок Location с URI нового объекта.
-
- Для успешных изменений без тела (PUT/PATCH/DELETE) отдавать 204 No Content
-
Использовать имена во множественном числе и существительные (/feedback/matches, /feedback/tournaments) вместо глаголов (add, user) в путях
-
Определить схему безопасности в
components/securitySchemes(bearerAuth) и подключитьsecurity: - bearerAuth: []ко всем защищённым эндпоинтам. -
Реализовать полный CRUD для отзывов:
GET /feedback/matches/{id}иGET /feedback/tournaments/{id}PUT /feedback/matches/{id}/PUT /feedback/tournaments/{id}DELETE /feedback/matches/{id}/DELETE /feedback/tournaments/{id}
-
Добавить пагинацию и фильтрацию к списковым GET (например,
limit,offsetили cursorafterId) и вернуть метаданные (total,next,prev). -
Перейти на единый стиль полей в теле запросов/ответов (camelCase вместо snake_case).
-
Указать
tags: [Feedback](или разделить на под-тегиMatchFeedback,TournamentFeedback) для структурирования документации. -
Добавить реальные примеры (
example/examples) для основных запросов и ответов.
Описание изменений
Добавлен контракт к сервису
Мотивация и контекст
Для согласования API
Тип изменений
Чек‑лист автора
feature/<key>