PHPackages                             single\_software/singles\_swagger - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. single\_software/singles\_swagger

ActiveLibrary[API Development](/categories/api)

single\_software/singles\_swagger
=================================

create dinamic api-docs

2.0.4(1y ago)026MITPHPPHP \*

Since Jun 3Pushed 1y ago1 watchersCompare

[ Source](https://github.com/beto066/single_swagger)[ Packagist](https://packagist.org/packages/single_software/singles_swagger)[ RSS](/packages/single-software-singles-swagger/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (9)Versions (14)Used By (0)

SingleSoftware Swagger Generator
================================

[](#singlesoftware-swagger-generator)

**Uma biblioteca para gerar documentação Swagger automaticamente para APIs Laravel, com base em FormRequests.**

---

Instalação
----------

[](#instalação)

Instale a biblioteca usando o Composer:

```
composer require single_software/singles_swagger
```

---

Funcionalidades
---------------

[](#funcionalidades)

### Rotas de Documentação

[](#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.php`

    Gera 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.php",
        "web.php",
        "api.json"
    ]
    ```
- `/api-doc/api.json`
    Disponibiliza a documentação Swagger no formato JSON para integração com ferramentas externas.

---

### Comando Artisan

[](#comando-artisan)

A biblioteca fornece um comando Artisan para gerar a documentação Swagger manualmente:

```
php artisan generate:swagger {routeFile} {--prefix=} {--tenants=}
```

#### Parâmetros do Comando:

[](#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
---------------

[](#exemplos-de-uso)

### 1. Gerar Documentação para um Arquivo de Rotas Específico

[](#1-gerar-documentação-para-um-arquivo-de-rotas-específico)

Acesse a rota:

```
http://sua-aplicacao.test/api-doc/api.php

```

Ou execute o comando Artisan:

```
php artisan generate:swagger api.php
```

### 2. Listar Todas as Rotas Disponíveis

[](#2-listar-todas-as-rotas-disponíveis)

Acesse:

```
http://sua-aplicacao.test/api-doc

```

### 3. Exportar Documentação como JSON

[](#3-exportar-documentação-como-json)

Acesse:

```
http://sua-aplicacao.test/api-doc/api.json

```

---

Benefícios
----------

[](#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
----------

[](#requisitos)

- Laravel 8 ou superior.
- PHP 7.4 ou superior.

---

Sobre
-----

[](#sobre)

Esta biblioteca foi desenvolvida pela **SingleSoftware** para facilitar a criação de documentações Swagger em projetos Laravel.

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance36

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

12

Last Release

711d ago

Major Versions

1.0.7 → 2.0.12024-06-05

PHP version history (2 changes)v1.0.0PHP ^8.2

2.0.1PHP \*

### Community

Maintainers

![](https://www.gravatar.com/avatar/d30a4794f261d18240b00c38aff86d4ed003bf045b8e41ff78c3c5f2d2d73204?d=identicon)[beto066](/maintainers/beto066)

---

Top Contributors

[![beto066](https://avatars.githubusercontent.com/u/75099154?v=4)](https://github.com/beto066 "beto066 (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/single-software-singles-swagger/health.svg)

```
[![Health](https://phpackages.com/badges/single-software-singles-swagger/health.svg)](https://phpackages.com/packages/single-software-singles-swagger)
```

###  Alternatives

[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9682.1M97](/packages/roots-acorn)[psalm/plugin-laravel

Psalm plugin for Laravel

3274.9M308](/packages/psalm-plugin-laravel)[flat3/lodata

OData v4.01 Producer for Laravel

96320.9k](/packages/flat3-lodata)[skagarwal/google-places-api

Google Places Api

1913.0M8](/packages/skagarwal-google-places-api)[api-platform/laravel

API Platform support for Laravel

59126.4k6](/packages/api-platform-laravel)[laragear/turnstile

Use Cloudflare's no-CAPTCHA with HTTP/3 in your Laravel application.

684.5k](/packages/laragear-turnstile)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)