Skip to content

firmino2611/panel-manager-apidoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

license

Para mais detalhes veja a documentação completa Wiki (ainda em construção)

Instalação

Instalando via composer

javascript composer require firmino/apidoc

Instalando manualmente, adicione a seguinte linha em seu arquivo composer.json:

javascript "firmino/apidoc": "dev-master"

Registre o ServiceProvider em config/app.php

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

Registre também o Facade no mesmo arquivo

'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

php php artisan vendor:publish --provider="Package\Firmino\Apidoc\Providers\ApiDocServiceProvider"

Rode as migrações

php php artisan migrate

Testando

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

Facade

O Facade disponivel no momento possui apenas dois métodos

Doc::getApis()

Retorna todas as Apis cadastrada

Doc::getParameters()

Retorna todos os parametros registrados

About

Pacote para gerenciamento de documentação de API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published