Existe alguma uso padrão de rota para obter a doc de uma api? public/docs seria esse padrão?
Existe alguma uso padrão de rota para obter a doc de uma api? public/docs seria esse padrão?
Olá Daniel! Tudo bem?
Não existe um padrão universalmente aceito para a rota onde a documentação de uma API deve estar disponível, mas é comum encontrar algumas convenções. Uma prática bastante utilizada é hospedar a documentação em rotas como /docs, /api-docs, ou /documentation. No exemplo que você mencionou, /public/docs é uma escolha válida e segue essa convenção.
O importante é que a rota seja intuitiva e fácil de lembrar para os desenvolvedores que irão utilizar a API. Além disso, é fundamental que a documentação seja clara e abrangente, facilitando o entendimento de como interagir com a API.
Conte com o apoio do fórum :)
Um abraço e bons estudos!
Obrigado, Rafaela