Achei meio surreal desenvolver uma documentação de api pra uma aplicação que nao existe ainda, acho que no mundo real é o inverso, acho que uma segunda parte explicando com adicionar uma api para uma aplicacao ja existente seria mais realista
Solucionado
Achei meio surreal desenvolver uma documentação de api pra uma aplicação que nao existe ainda, acho que no mundo real é o inverso, acho que uma segunda parte explicando com adicionar uma api para uma aplicacao ja existente seria mais realista
Opa, Daniel! Como vai?
Existe uma forma de desenvolvimento de web services chamada de contract first, nesse estilo de desenvolvimento primeiro é desenvolvido o contrato do WS, ou seja, a interface que irá mostrar o que aquele WS irá fazer. Uma das vantagens dessa abordagem é que o contrato é independente da linguagem utilizada para o desenvolvimento do WS, sendo assim, se no futuro quiséssemos trocar a linguagem utilizada, poderíamos manter o contrato intacto. Além disso, com o contrato pronto de cara, a documentação igualmente pode ser preparada antes mesmo do código ser implementado!
E aqui que vem a surpresa: essa é a abordagem que é indicada normalmente!
Sendo assim, embora essa prática possa não ser tão usual, ainda assim ela é possível e normalmente é a mais indicada!
Aliás, certamente vale uma busca pelo assunto contract first aí nas interwebs! O assunto é bem extenso e cheio de coisas interessantes!
Qualquer coisa é só falar!
Grande abraço e bons estudos, meu aluno!