PHPackages                             pablito/structure - 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. pablito/structure

ActiveLibrary

pablito/structure
=================

A basic structure for a RestApis environment

1.11(6y ago)02541MITPHP

Since Feb 14Pushed 6y agoCompare

[ Source](https://github.com/pablobilvao123/structure)[ Packagist](https://packagist.org/packages/pablito/structure)[ RSS](/packages/pablito-structure/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependencies (2)Versions (32)Used By (0)

Structure Basic Laravel 5
=========================

[](#structure-basic-laravel-5)

Structure Basic es un componente para Laravel. Nos permite crear una estrucutra básica y generar RestApis a partir de un archivo de configuración.

Tabla de Contenidos
-------------------

[](#tabla-de-contenidos)

- [Instalación](#instalación)
    - [Composer](#composer)
    - [Laravel](#laravel)
- [¿Cómo Funciona?](#cómo-funciona)
    - [Archivo Configuración](#archivo-configuración)
        - [Default Paths](#default-paths)
        - [Component Options](#component-options)
        - [Routes](#routes)
        - [Services (ejemplo)](#services-ejemplo)
        - [Services (estructura)](#services-estructura)
        - [Observer & Job](#observer--job)
- [Método Principal](#método-principal)

Instalación
-----------

[](#instalación)

### Composer

[](#composer)

Ejecutar el siguiente comando para descargar la última versión

```
composer require pablito/structure

```

### Laravel

[](#laravel)

#### >= laravel5.5

[](#-laravel55)

El ServiceProvider se cargará automáticamente

#### < laravel5.5

[](#-laravel55-1)

En tu `config/app.php` agrega `Structure\Basic\StructureServiceProvider::class` al final de `providers` array:

```
'providers' => [
    ...
    Structure\Basic\StructureServiceProvider::class,
],
```

¿Cómo funciona?
---------------

[](#cómo-funciona)

### Archivo Configuración

[](#archivo-configuración)

Lo primero que verás en el archivo de configuración (config/structure.php) será esto:

```
return [
  /* Default Paths */
  'paths' => [
      'contracts'    => 'App\Contracts\\',
      'models'       => 'App\Models\\',
      'observers'    => 'App\Observers',
      'repositories' => 'App\Repositories\\',
      'services'     => 'App\Services\\',
      'jobs'         => 'App\Jobs\\',
      'controller'   => 'App\Http\Controllers\API\\',
      'requests'     => 'App\Http\Requests\API\\',
      'resources'    => 'App\Http\Resources\\',
  ],

  /* Component Options */
  'replace_all'        => false,

  /* Your services here */
  'services' => [
  ],

  /* Your routes structure here (3 levels) */
  'routes' => [
    ['prefix' => '', 'middleware' => ['cors']], // level 1
    ['prefix' => '', 'middleware' => []], // level 2
    ['prefix' => '', 'middleware' => []] // level 3
  ],

  /* Example Syntax */
  'routes_example' => [
    ['prefix' => 'level-name1', 'middleware' => ['cors']], // level 1
    ['prefix' => 'level-name2', 'middleware' => []], // level 2
    ['prefix' => 'level-name3', 'middleware' => []] // level 3
  ],

  /* Example Syntax */
  'services_example' => [
    'services_name' => [
      'fillables'        => ["param1", "param2"],
      'fieldSearcheable' => ["param1" => "like"],
      'resources'        => ['param1', 'param2', 'param3'],
      'routes'           => ['index', 'store', 'update'],
      'rules_store'      => [],
      'rules_update'     => [],
      'observer'         => FALSE
    ]
  ]
];
```

#### Default Paths

[](#default-paths)

Aca tenemos la estructura de carpetas por default que utiliza el componente. Lo recomendable es mantener la misma, pero puede ser modificada. Lo que debe estar y no es opcional, son todos los path configurados.

#### Component Options

[](#component-options)

- replace\_all => boolean /\* Si es `true`, cuando ejecute el command principal reemplazará todos los archvos de los servicios que ya existen. Si es `false` creará solo los que no esten. \*/

#### Routes

[](#routes)

En la versión actual y estable cuenta con 3 niveles (no es opcional la cantidad). Esta sección se configura cuales son los prefix y si necesitan algún middleware. Es bastante limitante lo que puede hacer esta parte. Pero puede setear el replace\_all en false y crear su archivo de `api.php` personalizado.

- prefix => string
- middleware => array()

#### Services (ejemplo)

[](#services-ejemplo)

En esta sección van configurados nuestros servicios, por ejemplo: si necesito crear un Api que me devuelva un `json` con los roles de mi base de datos configuro mi servicio de la siguiente manera:

Ejemplo:

```
  'services' => [
    'roles' => [
      'fillables'         => ["name", "country_name"],
      'fieldSearcheable'  => ["name" => "like", "country_name"],
      'resources'         => ['id', 'name', 'country_name'],
      'routes'            => ['index'],
      'rules_store'       => [],
      'rules_update'      => [],
      'observer'          => FALSE
    ]
  ]
```

Resultado:

Puede usarlo de dos maneras:

- Con Request: `http://structure.local/api/prefix1/prefix2/prefix3/roles`

```
{
  "data": [
    {
      "id": "1",
      "name": "Admin",
      "country_name": "Argentina"
    },
    {
      "id": "2",
      "name": "Supervisor",
      "country_name": "Chile"
    }
  ]
}
```

Para saber como filtrar que campos necesito traer o filtrar por algún name en particular ver las opciones en: [Example Repositories](https://github.com/andersao/l5-repository#example-the-criteria)

- Si lo queres utilizar desde algún lugar de tu código, tendrás que declarar el uso de la interfaz de tu servicio en la clase donde lo vas a utilizar. Veamos un ejemplo:

```
    namespace App\Http\Controllers\API;
    use App\Http\Controllers\Controller;
    use App\Http\Resources\RoleResource;
    use App\Contracts\RoleInterface;

    class RoleController extends Controller
    {
        public function __construct( RoleInterface $role ){
            $this->role = $role;
        }

        public function index(){
            return RoleResource::collection( $this->role->index() );
        }
    }
```

ACLARACION: El nombre de la interfaz pasará de esto: `nombre_servicio_en_ingles_plural` (nombre del servicio en el archivo de configuración) a esto `NombreServicioEnInglesSingularInterface`.

#### Services (estructura)

[](#services-estructura)

```
'services' => [
    'service_name' => [
      'fillables'        => ["param1", "param2"],
      'fieldSearcheable' => ["param1" => "like"],
      'resources'        => ['param1', 'param2', 'param3'],
      'routes'           => ['index', 'store', 'update'],
      'rules_store'      => [],
      'rules_update'     => [],
      'observer'         => FALSE
    ]
  ]
```

- `service_name`: nombre de tu servicio (o de la tabla en base de datos) preferiblemente en ingles y plural
- `fillable`: los atributos de la tabla en cuestión
- `fieldSearcheable`: los atributos que quieren incluir en filtros. Sigue esta regla `"atributo" => "condition"`, vea que si no especifíca el `condition` tomará por default `"="`
- `resources`: los atributos que necesitan que se devuelva en el json de respuesta. Si deja el array vacío devolverá todos los atributos de la tabla y podra filtrarlos utilizando el parámetro `filter` en su petición `GET`
- `routes`: en la versión actual se puede declarar 3 opciones, `index` para los GET, `store` para los POST y `update` para los PUT. A partir de estas opciones se crearán los métodos disponibles y las rutas. Ej de uso: `app('role')->update($atributos, $id);` No es necesario que específiqe las 3, puede solo necesitar una sola.
- `rules_store`: En caso de usar `store` puede específicar las reglas de validación teniendo en cuenta la documentación de [Laravel](https://laravel.com/docs/5.7/validation#form-request-validation)
- `rules_update`: En caso de usar `update` puede específicar las reglas de validación teniendo en cuenta la documentación de [Laravel](https://laravel.com/docs/5.7/validation#form-request-validation)
- `observer`: recibe un boolean, si es `true` le creará una clase en la carpeta de `observers`. Tenga en cuenta la documentación de [Laravel](https://laravel.com/docs/5.7/eloquent#observers)

#### Observer & Job

[](#observer--job)

Cuando en nuestro service configuramos el `observer => true` nos creará la clase Observer con el nombre de nuestro servicio en el path configurado. No es necesario registrar el observer, lo tomará automáticamente. Si bien, los observers se pueden utilizar para diferentes funcionalidades, en el packages está pensado principalmente para la sincronización de datos a través de colas de procesos. No quita que lo puedas utilizar para realizar otra cosa.

Para poder utilizarlo, primero tenes que configurar algún driver para queues. Tenga en cuenta la documentación de [Laravel](https://laravel.com/docs/5.7/queues)

Una vez configurado, lo único que hay que configurar para utilizar la sincronización es configurar los datos del api que va a consumir para sincronizar (o las apis). La clase observer ya tendrá lo necesario para hacerlo.

Método Principal
----------------

[](#método-principal)

Una vez configurado el archivo, o cada vez que lo modifiquemos tendremos que correr un comando de ArtisanCLI para indicarle a nuestra aplicación que hay nuevos o modificaciones en nuestros servicios básicos.

Command:

```
php artisan build:structure
```

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity12

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity71

Established project with proven stability

 Bus Factor1

Top contributor holds 77.8% 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 ~4 days

Recently: every ~23 days

Total

31

Last Release

2513d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/85349deb2ead5f45a96888bb126807e31b7b566b1c01a93b639ba59572ce16d5?d=identicon)[pablobilvao](/maintainers/pablobilvao)

---

Top Contributors

[![pablo-bilvao](https://avatars.githubusercontent.com/u/47643656?v=4)](https://github.com/pablo-bilvao "pablo-bilvao (7 commits)")[![JABvzla](https://avatars.githubusercontent.com/u/11053039?v=4)](https://github.com/JABvzla "JABvzla (2 commits)")

---

Tags

basiccomposerestructuralaravellaravel-5-packagephprest-api

### Embed Badge

![Health badge](/badges/pablito-structure/health.svg)

```
[![Health](https://phpackages.com/badges/pablito-structure/health.svg)](https://phpackages.com/packages/pablito-structure)
```

###  Alternatives

[bagisto/bagisto

Bagisto Laravel E-Commerce

26.2k161.6k7](/packages/bagisto-bagisto)[krayin/laravel-crm

Krayin CRM

22.0k32.8k1](/packages/krayin-laravel-crm)[unopim/unopim

UnoPim Laravel PIM

9.4k1.8k](/packages/unopim-unopim)[apiato/core

Core package for Apiato.

70335.0k5](/packages/apiato-core)[acoustep/entrust-gui

A GUI for the Entrust package.

11425.7k](/packages/acoustep-entrust-gui)

PHPackages © 2026

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