Minha visão maninho, programar software é algo quase pessoal. A pessoa que cria uma API sempre leva consigo ao codar idioms de outras experiências, as vezes quer aplicar algo "novo" excepcionalmente nessa API, as vezes tem o próprio modus operandi a mais de 10 anos, e mesmo com erros e falhas nunca muda, e outras vezes até fica uma bagunça, um dev começa bem, outro vem e implementa algo de forma não ortodoxa, um terceiro entra e muda totalmente o paradigma... são muitos fatores, mas isso falando ainda do software/API em si.

Sobre a documentação, não é difícil. Apenas é chato para algumas pessoas, e digo chato mesmo. É muito legal codar, criar as coleções no postman, integrar com um banco de dados, testes unitarios, etc. A documentação é algo que geralmente fica por ultimo, isso quando existe. Documentação de software deve ocorrer conforme o projeto evolui, ao mesmo tempo, e se possível em mais de um lugar. Uma boa API tem uma boa base teórica, quase como uma wiki, que mostra o que pode ou não ser enviado nela por exemplo, o bom e velho swagger para consultas rápidas, um dev experiênte a disposição para modificar ou dar suporte, e um ambiente de testes para ser usado durante a integração.

Já trabalhei com muitas APIs governamentais, algumas tive o prazer de encontrar um PDF perdido no site, outras tive que ir caçando as chamadas que ocorriam no site pra integrar do meu lado... essas APIs são o verdadeiro inferno. E além disso, você encontra de todo tipo: SOAP, REST, GraphQL, RPC, transferência de arquivos em rede (bancos usam esse tipo, mexi bem pouco).... Infelizmente é a nossa realidade.