Sobes.tech
Junior — Middle

Em que parte da estrutura do sistema está localizada a documentação da API que corresponde aos princípios da arquitetura limpa?

sobes.tech IA

Resposta da IA

De acordo com os princípios da arquitetura limpa, a documentação da API deve estar na fronteira do sistema, ou seja, na camada de adaptadores de interface ou ao nível das interfaces externas (por exemplo, manipuladores HTTP, serviços gRPC).

Isto está relacionado com o facto de:

  • As camadas internas (lógica de negócio, domínio) não devem depender dos detalhes de implementação da API.
  • A documentação da API descreve os contratos de interação com o mundo exterior e deve refletir exatamente essas interfaces.

Assim, a documentação geralmente fica ao lado do código que implementa os adaptadores e interfaces que ligam a lógica interna aos clientes externos.

Por exemplo, num projeto Go, isto pode ser uma pasta com manipuladores HTTP e especificações swagger/openapi correspondentes.