Тазалык архитектурасынын принциптерине ылайык келген API документтеринин системанын структурасында кайда жайгашкан?

Таза архитектуранын принциптерине ылайык, APIнин документтери системанын чегинде жайгашышы керек, башкача айтканда, интерфейс адаптерлеринин катмында же тышкы интерфейс деңгээлдеринде (мисалы, HTTP иштетүүчүлөр, gRPC кызматтары).

Бул төмөнкүлөр менен байланыштуу:

• Ички катмдар (бизнес логикасы, домен) APIнин ишке ашырылышынын деталдарынан көз каранды болбошу керек.
• APIнин документтери тышкы дүйнө менен өз ара аракеттенүү келишимдерин сүрөттөйт жана так ошол интерфейстерди чагылдыруусу керек.

Ошондуктан, документтер адатта ички логиканы тышкы кардарлар менен байланыштырып турган адаптерлер жана интерфейстерди ишке ашыруу кодунун жанында жайгашкан.

Мисалы, Go долбоорунда бул HTTP иштетүүчүлөр жана тиешелүү swagger/openapi спецификациялары менен папка болушу мүмкүн.