firmino/apidoc

Pacote com painel para gerenciamento de documentacao de API's

Panel Manager Api Doc

Pacote para gerenciamento de documentação de API. Este pacote está em desenvolvimento, porém ja é possível usa-lo para gerenciar a documentação de suas API's., _(*1)

, _(*2)

Para mais detalhes veja a documentação completa (ainda em construção), _(*3)

Instalação

Instalando via composer, _(*4)

javascript composer require firmino/apidoc, _(*5)

Instalando manualmente, adicione a seguinte linha em seu arquivo composer.json:, _(*6)

javascript "firmino/apidoc": "dev-master", _(*7)

Registre o ServiceProvider em config/app.php, _(*8)

'providers' => [
      Package\Firmino\Apidoc\Providers\ApiDocServiceProvider::class,
]

Registre também o Facade no mesmo arquivo, _(*9)

'aliases' => [
      'Doc' => Package\Firmino\Apidoc\Facades\Apidoc::class,
]

Publicando arquivos

Execute o comando abaixo para publicar os arquivos necessários para a configuração do painel, _(*10)

php php artisan vendor:publish --provider="Package\Firmino\Apidoc\Providers\ApiDocServiceProvider", _(*11)

Rode as migrações, _(*12)

php php artisan migrate, _(*13)

Testando

Acesse a rota padrão /apidoc para visualizar o painel. Esta informação pode ser alterada no arquivo de configurações., _(*14)

Facade

O Facade disponivel no momento possui apenas dois métodos, _(*15)

Doc::getApis()

Retorna todas as Apis cadastrada, _(*16)

Doc::getParameters()

Retorna todos os parametros registrados, _(*17)