PHPackages                             nabysyphpapi/xnabysygs - 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. [Framework](/categories/framework)
4. /
5. nabysyphpapi/xnabysygs

ActiveComposer-plugin[Framework](/categories/framework)

nabysyphpapi/xnabysygs
======================

Framework de mise en place rapide d'API pour les plateformes d'application développé par PAM et MCP. (EN: Rapid API implementation framework for application platforms developed by PAM and MCP)

v1.6.0(1w ago)1264[1 PRs](https://github.com/paulisidore/NAbySyPhpApi/pulls)mitPHPPHP >=8.1.0

Since Apr 24Pushed 1w ago1 watchersCompare

[ Source](https://github.com/paulisidore/NAbySyPhpApi)[ Packagist](https://packagist.org/packages/nabysyphpapi/xnabysygs)[ RSS](/packages/nabysyphpapi-xnabysygs/feed)WikiDiscussions main Synced today

READMEChangelog (2)Dependencies (8)Versions (96)Used By (0)

NAbySyGS - Framework PHP avec ORM Intégré
=========================================

[](#nabysygs---framework-php-avec-orm-intégré)

[![Latest Version](https://camo.githubusercontent.com/7c9222f6a5de06f332f54b5f21367a1afca5760b942613290efb63683bc56f5a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6e61627973797068706170692f786e616279737967732e737667)](https://packagist.org/packages/nabysyphpapi/xnabysygs)[![Total Downloads](https://camo.githubusercontent.com/746d6bbb47afb054d6fa7a1ba714a3a0a32f857ab2edaa19590aecf2cd2a1516/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6e61627973797068706170692f786e616279737967732e737667)](https://packagist.org/packages/nabysyphpapi/xnabysygs)[![License](https://camo.githubusercontent.com/b7000d949d5090f71f15e346a15f3cdc3bbbe11e82c4951503275b584fde30ff/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6e61627973797068706170692f786e616279737967732e737667)](https://packagist.org/packages/nabysyphpapi/xnabysygs)[![PHP Version](https://camo.githubusercontent.com/96596690a5c530e24a0858796c5f4a72a660a7c48800aad039a6b2a249f8dd4c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6e61627973797068706170692f786e616279737967732e737667)](https://packagist.org/packages/nabysyphpapi/xnabysygs)

**NAbySyGS** est un framework PHP moderne conçu par **PAM & MCP** pour faciliter la création rapide d'API REST pour vos applications. Il intègre un ORM personnalisé avec création automatique de tables et champs, un système d'authentification JWT, une architecture modulaire, et un double système de routage (Action classique + URL Laravel-style).

---

✨ Fonctionnalités
-----------------

[](#-fonctionnalités)

- 🚀 **ORM Automatique** — Création automatique des tables et champs MySQL/MariaDB
- 🔗 **Jointures ORM Fluentes** — API de jointure chainable entre entités, sans écrire de SQL
- 🔐 **Authentification JWT** — Système de tokens sécurisés intégré
- 📦 **Architecture Modulaire** — Organisation en modules avec auto-chargement
- 🎯 **Type-Safe** — Détection automatique des types de données (INT, VARCHAR, DATE…)
- 🔄 **Gestion d'Événements** — Pattern Observer pour réagir aux changements
- 🌐 **Double Routage** — Routage par Action classique **et** routage URL Laravel-style, simultanément
- 🛡️ **Middlewares** — Appliqués automatiquement, personnalisables par le développeur
- 📋 **Documentation des Routes Intégrée** — Endpoint `/api/describe` avec rendu web interactif, export JSON/PDF et import
- 🛠️ **Modules Métier** — Gestion de boutiques, stocks, factures, clients…
- 🌐 **CORS Ready** — Gestion automatique des requêtes cross-origin
- 📝 **Logs Intégrés** — Journalisation système et débogage
- 🎛️ **Setup HTML Interactif** — Configuration initiale via interface web, ouverte automatiquement au premier lancement

---

📋 Prérequis
-----------

[](#-prérequis)

- PHP >= 8.1.0
- MySQL ou MariaDB
- Extensions PHP : `mysqli`, `mbstring`, `json`
- Composer

---

📦 Installation
--------------

[](#-installation)

### Via Composer

[](#via-composer)

```
composer require nabysyphpapi/xnabysygs
```

### Via la CLI NAbySyGS (`koro` / `nsy`)

[](#via-la-cli-nabysygs-koro--nsy)

```
# Installer la CLI globalement
composer global require nabysyphpapi/xnabysygs-cli

# Initialiser un nouveau projet dans le dossier courant
koro init mon-projet-api
```

> Voir la documentation de la CLI pour le détail des commandes disponibles.

### 🎛️ Setup Initial Automatique

[](#️-setup-initial-automatique)

Lors de la **première installation** (via `composer require` ou via n'importe quelle commande `koro`), NAbySyGS ouvre automatiquement **`setup.html`** dans votre navigateur par défaut.

Cette interface web vous permet de configurer :

- La connexion à la base de données
- L'URL du serveur
- Le nom de l'application et les informations client

Une fois le formulaire validé, **`appinfos.php`** est généré automatiquement à la racine de votre projet. Le setup ne s'ouvrira plus automatiquement par la suite.

> ⚠️ Toute commande `koro` (sauf `koro version`) déclenche cette vérification et ouvre le setup si le projet n'est pas encore configuré.

### Structure Générée

[](#structure-générée)

```
votre-projet/
├── vendor/
│   └── nabysyphpapi/xnabysygs/
├── gs/                         # Modules personnalisés (créés automatiquement)
│   └── client/
│       ├── client_action.php   # Endpoints Action API
│       └── xClient/
│           └── xClient.class.php  # Classe ORM
├── appinfos.php                # Configuration (généré par setup.html)
├── db_structure.php            # Déclaration des modules et routes
├── .htaccess                   # Redirection API (créé automatiquement)
└── index.php                   # Point d'entrée

```

---

🚀 Démarrage Rapide
------------------

[](#-démarrage-rapide)

### 1. Configuration Initiale

[](#1-configuration-initiale)

Créez un fichier `index.php` à la racine :

```