A rendszer szerkezetében hol található az API dokumentáció, amely megfelel a tiszta architektúra elveinek?

A tiszta architektúra elvei szerint az API dokumentációnak a rendszer határán kell elhelyezkednie, azaz az interfész adapterek rétegében vagy a külső interfészek szintjén (például HTTP kezelők, gRPC szolgáltatások).

Ez abból adódik, hogy:

• A belső rétegek (üzleti logika, domain) nem függhetnek az API megvalósításának részleteitől.
• Az API dokumentáció leírja a külső világgal való interakciós szerződéseket, és pontosan ezeket az interfészeket kell tükröznie.

Ezért általában a dokumentáció a kód mellett található, amely az adaptereket és az interfészeket valósítja meg, amelyek összekötik a belső logikát a külső kliensekkel.

Például egy Go projektben ez lehet egy mappa HTTP kezelőkkel és a megfelelő swagger/openapi specifikációkkal.