Skip to content

OpenAPI

Kaynak dosya

backend/api/openapi.yaml deponun tek OpenAPI kaynağıdır. Uygulama bu dosyayı okuyup iki uçtan sunar:

Uç İçerik
GET /openapi.yaml Dosyanın ham hâli
GET /openapi.json js-yaml ile JSON'a çevrilmiş hâli

Source: backend/src/routers/docs.routes.ts

Arayüz

Backend Swagger UI HTML'i sunmaz. Arayüz React SPA içindeki /api-docs rotasındadır (dashboard/src/components/api-docs/SwaggerDocs.tsx) ve dokümanı yukarıdaki /openapi.json ucundan çeker.

Bağlama sırası

docsRoutes, tüm API router'larından sonra, notFoundHandler ve errorHandler'dan önce bağlanır; mevcut router sırası değişmez.

Bilinen boşluk

backend/api/openapi.yaml içinde /health yolu tanımlı değildir. Sağlık ucu çalışır ve kurulum betikleri onu kullanır, ancak API sözleşmesinde belgelenmemiştir; dolayısıyla Swagger arayüzünde görünmez.