In quale parte della struttura del sistema si trova la documentazione API che rispetta i principi dell'architettura pulita?

Secondo i principi dell'architettura pulita, la documentazione API dovrebbe trovarsi alla frontiera del sistema, cioè nello strato degli adattatori di interfaccia o a livello delle interfacce esterne (ad esempio, gestori HTTP, servizi gRPC).

Ciò è legato al fatto che:

• Gli strati interni (logica di business, dominio) non devono dipendere dai dettagli di implementazione dell'API.
• La documentazione API descrive i contratti di interazione con il mondo esterno e deve riflettere esattamente queste interfacce.

Pertanto, la documentazione si trova di solito accanto al codice che implementa gli adattatori e le interfacce che collegano la logica interna con i clienti esterni.

Ad esempio, in un progetto Go, può essere una cartella con gestori HTTP e specifiche swagger/openapi corrispondenti.