Təmiz memarlıq prinsiplərinə uyğun API sənədləşməsi sistemin strukturunda harada yerləşir?

Təmiz memarlıq prinsiplərinə uyğun olaraq, API sənədləri sistem sərhədində yerləşməlidir, yəni interfeys adapterləri qatında və ya xarici interfeyslər səviyyəsində (məsələn, HTTP handlerləri, gRPC xidmətləri).

Bu, odur ki:

• Daxili qatlar (iş məntiqi, domen) API-nin həyata keçirilməsi detalları ilə bağlı olmamalıdır.
• API sənədləri xarici dünya ilə qarşılıqlı əlaqə müqavilələrini təsvir edir və dəqiq bu interfeysləri əks etdirməlidir.

Buna görə də, sənədlər adətən daxili məntiqi xarici müştərilərlə əlaqələndirən adapterlər və interfeysləri həyata keçirən kodla yanaşı yerləşir.

Məsələn, Go layihəsində bu, HTTP handlerləri və müvafiq swagger/openapi spesifikasiyaları olan qovluq ola bilər.