Gerando Documentação Automática no LARAVEL

Criar uma documentação dos projetos nunca é uma tarefa fácil, mas é necessário e muitas vezes negligenciada. Nessa publicação, apresento uma biblioteca que faz a geração automática de documentação dos projetos em Laravel, basta especificar as annotations.

Quando fiz alguns vídeos sobre como criar uma API no lumen/laravel, alguém me perguntou (não lembro quem) nos comentários sobre algum gerador de documentação. Na época respondi e acabei não gravando nada pois não tinha nenhuma ferramenta em mãos. Hoje venho compartilhar uma biblioteca muito boa, útil e fácil de instalar.

Esse projeto está disponível no github e pode ser instalado através do composer no projeto que você desejar gerar a documentação. Além do laravel, tem suporte com lumen e dingo.

Para instalar, basta ter um projeto do laravel rodando ou criar um novo e adicionar as dependências no projeto.

No laravel

Depois basta publicar o arquivo de configuração dentro do /config, com o seguinte comando:

O comando acima vai gerar um arquivo apidoc.php dentro da pasta config do laravel.

No Lumen

No lumen basta registrar o service provider dentro do bootstrap/app.php

E copiar o arquivo de configuração do  vendor/mpociot/laravel-apidoc-generator/config/apidoc.php 

para config/apidoc.php  e por fim, adicionar no boostrap/app.php a seguinte linha:

Veja o vídeo completo onde faço todo a configuração necessária para gerar documentações de forma automática!