Fix: @SecurityScheme in=HEADER — Swagger UI не клал ключ в заголовок #5

Merged
pjandro merged 1 commits from fix/security-scheme-in-header into main 2026-10-16 00:26:30 +03:00
Collaborator

Проблема (найдена браузерным E2E на проде после мержа #4)

Swagger UI открывался, Authorize принимал ключ (localStorage authorized заполнен), но «Try it out» слал POST /api/v1/convert без X-API-Key → 401. Причина: при правке apiKeyName→paramName в #4 строка in = SecuritySchemeIn.HEADER была срезана — в спеке apiKey-схема осталась без обязательного поля in (jq .components.securitySchemes на проде это подтверждает), swagger-ui не знает, куда положить ключ.

Изменения

  • OpenApiConfig: вернуть in = SecuritySchemeIn.HEADER (импорт уцелел).
  • ApiKeyFilterTest#docsOpenWithoutKey: assert $.components.securitySchemes.ApiKey.in == "header" — прежние assert type+name не покрывали ровно этот регресс.

Проверка

  • mvn clean verify — BUILD SUCCESS (core 104 + app 22).
  • Локальный браузерный E2E на java -jar (ключ probe): spec securitySchemes.ApiKey содержит "in":"header"; Authorize → Try it out → Execute: запрос ушёл с x-api-key: probe, ответ 200.

После мержа: пересобрать прод (restart.sh --build) и повторить браузерный E2E на https://pjandro.ru/pdf-converter/swagger-ui.html.

## Проблема (найдена браузерным E2E на проде после мержа #4) Swagger UI открывался, Authorize принимал ключ (localStorage `authorized` заполнен), но «Try it out» слал `POST /api/v1/convert` **без** `X-API-Key` → 401. Причина: при правке `apiKeyName→paramName` в #4 строка `in = SecuritySchemeIn.HEADER` была срезана — в спеке apiKey-схема осталась без обязательного поля `in` (`jq .components.securitySchemes` на проде это подтверждает), swagger-ui не знает, куда положить ключ. ## Изменения - `OpenApiConfig`: вернуть `in = SecuritySchemeIn.HEADER` (импорт уцелел). - `ApiKeyFilterTest#docsOpenWithoutKey`: assert `$.components.securitySchemes.ApiKey.in == "header"` — прежние assert type+name не покрывали ровно этот регресс. ## Проверка - `mvn clean verify` — BUILD SUCCESS (core 104 + app 22). - Локальный браузерный E2E на `java -jar` (ключ `probe`): spec `securitySchemes.ApiKey` содержит `"in":"header"`; Authorize → Try it out → Execute: запрос ушёл с `x-api-key: probe`, ответ **200**. После мержа: пересобрать прод (`restart.sh --build`) и повторить браузерный E2E на `https://pjandro.ru/pdf-converter/swagger-ui.html`.
ai added 1 commit 2026-10-16 00:25:46 +03:00
При правке apiKeyName→paramName строка in = SecuritySchemeIn.HEADER была
срезана; в спеке apiKey-схема осталась без обязательного in — Swagger UI
не знал, куда положить ключ, и «Try it out» слал запросы без X-API-Key
(401; обнаружено браузерным E2E на проде после мержа #4). Тест
docsOpenWithoutKey теперь пинит in == header (прежних assert type+name
не хватало ровно на это). Локальный E2E (jar + браузер): запрос с
x-api-key, ответ 200.
pjandro merged commit 7193ba19be into main 2026-10-16 00:26:30 +03:00
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: pjandro/java-word-pdf#5