Download the PHP package single_software/singles_swagger without Composer
On this page you can find all versions of the php package single_software/singles_swagger. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download single_software/singles_swagger
More information about single_software/singles_swagger
Files in single_software/singles_swagger
Package singles_swagger
Short Description create dinamic api-docs
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package singles_swagger
SingleSoftware Swagger Generator
Uma biblioteca para gerar documentação Swagger automaticamente para APIs Laravel, com base em FormRequests.
Instalação
Instale a biblioteca usando o Composer:
Funcionalidades
Rotas de Documentação
Após instalar a biblioteca, você poderá acessar a documentação Swagger gerada automaticamente através das seguintes rotas:
-
/api-doc/{routeName}
Exemplo:/api-doc/api.phpGera a documentação Swagger para um arquivo de rotas específico.
-
/api-doc
Lista todas as rotas disponíveis para documentação.
Exemplo de saída: /api-doc/api.json
Disponibiliza a documentação Swagger no formato JSON para integração com ferramentas externas.
Comando Artisan
A biblioteca fornece um comando Artisan para gerar a documentação Swagger manualmente:
Parâmetros do Comando:
-
{routeFile}
O nome do arquivo de rotas para o qual a documentação será gerada.
Exemplo:api.php -
{--prefix=}
Um prefixo para as rotas que deve ser considerado na documentação.
Exemplo:--prefix=api/v1 {--tenants=}
Indica que as rotas pertencem a um sistema com múltiplos tenants (multitenancy).
Exemplo:--tenants=true
Exemplos de Uso
1. Gerar Documentação para um Arquivo de Rotas Específico
Acesse a rota:
Ou execute o comando Artisan:
2. Listar Todas as Rotas Disponíveis
Acesse:
3. Exportar Documentação como JSON
Acesse:
Benefícios
- Automação Completa: Geração automática de documentação com base em validações definidas em
FormRequest. - Flexibilidade: Suporte a sistemas com múltiplos tenants e rotas com prefixos personalizados.
- Integração Simples: Use o formato JSON para integrar a documentação com ferramentas externas, como Swagger UI.
Requisitos
- Laravel 8 ou superior.
- PHP 7.4 ou superior.
Sobre
Esta biblioteca foi desenvolvida pela SingleSoftware para facilitar a criação de documentações Swagger em projetos Laravel.
All versions of singles_swagger with dependencies
spatie/laravel-settings Version *
laravel/framework Version *
illuminate/container Version *
illuminate/events Version *
illuminate/routing Version *