Solucionado (ver solução)
Solucionado
(ver solução)
1
resposta

[Dúvida] Como melhor utilizar open api em Laravel?

Prezados,

Eu programei minha vida toda em NestJs para backend e me acostumei muito a documentar meu codigo usando decorators nas funçoes de controllers e a minha documentação do swagger aparecer com todos os schemas, rotas etc pronto. Porém atualmente estou migrando uma api do NestJs para o Laravel e não encontrei um bom jeito de documentar a minha api pelo swagger, o mais perto que cheguei a encontrar foi uma lib que utiliza das anotations do php.doc e gera a documentação, porém me parece que em metodos extensos isso vai deixar meu codigo muito poluido e de dificil manutenção. Outro caminho pensado foi desenvolver o json manualmente mas sinto que rodaria muito trabalho para fazer dessa forma. Alguma sugestão de como documentar sua api de forma mais automatica em laravel?

1 resposta
solução!

Opa, Lucca! Tudo joia?

Uma opção é utilizar o pacote "L5-Swagger", que é uma implementação do Swagger para o Laravel. Com ele, você pode documentar sua API utilizando anotações no código e gerar a documentação automaticamente. Você pode encontrar mais informações sobre como utilizá-lo na documentação oficial do pacote.

Outra opção é o pacote "DingoAPI", que também permite documentar sua API utilizando anotações no código. Ele oferece recursos adicionais, como autenticação e controle de acesso, além da documentação automática. Vale a pena dar uma olhada nesse pacote também.

Além disso, você também pode considerar utilizar ferramentas externas, como o Postman ou o Insomnia, para documentar e testar sua API. Essas ferramentas permitem criar coleções de requisições e adicionar descrições e exemplos para cada rota, facilitando a documentação.

Espero que essas sugestões te ajudem. Se tiver mais alguma dúvida, estarei à disposição.

Grande abraço e bons estudos!

Caso este post tenha lhe ajudado, por favor, marcar como solucionado ✓.