Estou começando agora na área e talvez não consiga abstrair algumas coisas ainda.
Qual a utilidade/necessidade dessa rota criada e em gerar essa resposta em HTML?
Você está vendo a versão anterior da nova experiência da Alura que estamos preparando para você. Em breve, ela ganha uma identidade visual novinha totalmente pensada em potencializar seus estudos!
Solucionado
Estou começando agora na área e talvez não consiga abstrair algumas coisas ainda.
Qual a utilidade/necessidade dessa rota criada e em gerar essa resposta em HTML?
Oii, Marconi.
É muito comum no começo a gente se perguntar o porquê de criar uma rota que não “faz nada com dados” e ainda por cima devolver HTML. Vamos por partes para deixar isso mais claro.
1.O propósito da rota de documentação
A ideia de criar a rota /public/docs é simular uma prática real de desenvolvimento de APIs. Em projetos profissionais, quando o time de back-end constrói uma API, precisa compartilhar com o time de front-end (ou mesmo outros serviços) como usar essa API: quais endpoints existem, que métodos HTTP devem ser usados, se há parâmetros, etc.
Existem ferramentas mais sofisticadas para isso (como o Swagger), mas antes de chegar nelas é importante entender a lógica básica: a documentação nada mais é do que um recurso exposto pela própria API, só que voltado para seres humanos, não para máquinas.
Ou seja, se você fosse entregar a documentação em JSON, quem fosse ler teria que interpretar manualmente as chaves e valores. Já em HTML, basta abrir no navegador e ver uma página legível, organizada e “amigável”.
O exercício serve para mostrar:
É como se fosse um primeiro passo para entender que uma API não serve só para “entregar dados”, mas também pode oferecer informações úteis sobre si mesma.
Por isso, a utilidade dessa rota é didática: mostrar como compartilhar a documentação de forma simples e como o formato da resposta (definido no cabeçalho Content-Type) muda totalmente a experiência de quem consome a API. Em um projeto real, essa documentação ajudaria o time de front-end a saber quais endpoints estão disponíveis e como usá-los.
Espero ter ajudado.
Conte com o apoio da comunidade Alura na sua jornada. Abraços e bons estudos!
Muito obrigado pela ótima resposta Lorena, agora sim ficou mais claro!