doc: три дополнительных вопроса Соннету — requestInterceptor, docExpansion, examples

This commit is contained in:
2026-08-01 19:19:17 +04:00
parent 9fb21a40a8
commit ede5b68b74
@@ -54,6 +54,33 @@
- Не усложнять — полигон это мок, не прод - Не усложнять — полигон это мок, не прод
- Не предлагать автогенерацию из кода через декораторы - Не предлагать автогенерацию из кода через декораторы
## Дополнительные вопросы
### requestInterceptor и X-Mock-Auth
Сейчас `swagger.html` добавляет только `Authorization: Bearer` через `requestInterceptor`.
Но `_mock/*` эндпоинты проверяют заголовок `X-Mock-Auth`, а не `Authorization`.
Как правильно дописать `requestInterceptor` чтобы оба механизма работали:
- `Authorization: Bearer <token>` — для всех эндпоинтов (если включена глобальная auth)
- `X-Mock-Auth: <token>` — только для `_mock/*`
### docExpansion
Какое значение `docExpansion` оптимально для Swagger UI 5?
- `"list"` — раскрыты только названия тегов (средний вариант)
- `"none"` — всё свёрнуто (минимализм)
- `"full"` — все эндпоинты раскрыты (но может быть перегружено)
Учитывая что есть 5 тегов (services, instances, operations, health, mock) и ~17 эндпоинтов.
### Примеры ответов (examples)
В каких схемах стоит добавить `example` чтобы Try it out был максимально полезен?
Например:
- `Instance` с реальными данными (instanceUid, serviceId, status, state.params, state.out)
- `CfsParam` с valueList (чтобы было видно как выглядят enum-параметры)
- `Operation` до run (dtStart=null, dtFinish=null) и после run (всё заполнено)
## Формат ответа ## Формат ответа
Сгруппируй находки так: Сгруппируй находки так: