mpa/logisticsAPI
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
657c5ad5e3d8f35e6bf2e6790096b880eb0d1e86
logisticsAPI/README.md
Marvin 657c5ad5e3 Update project dependencies and enhance documentation 
- Added `barryvdh/laravel-dompdf` to `composer.json` for PDF generation capabilities.
- Updated `boost.json` to include `tailwindcss-development` in skills.
- Modified `package.json` and `package-lock.json` to upgrade Tailwind CSS and related packages.
- Improved README.md for clarity and corrected French language errors.
- Created design system documentation for Filament components.
- Added new Filament pages for Dashboard and Documentation with dynamic content loading.
- Enhanced TablesExplorer functionality with improved table and column management.
2026-02-20 14:16:24 +01:00

2.4 KiB
Raw Blame History

API Logistics

Application Laravel 12 de test pour comprendre et documenter l'API Logistics (Flex/ESI Gescom). Elle fournit un dashboard Filament v5 permettant d'interroger les différents endpoints de l'API.

Prérequis

  • PHP 8.4+
  • Composer
  • Node.js et npm
  • MySQL

Installation

git clone <repo-url>
cd api-logistics
composer install
npm install
cp .env.example .env
php artisan key:generate

Configuration

Base de données

Créer une base de données MySQL nommée api_logistics, puis configurer le fichier .env :

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api_logistics
DB_USERNAME=root
DB_PASSWORD=

Exécuter les migrations :

php artisan migrate

API Logistics

Configurer la connexion à l'API Logistics dans le fichier .env :

LOGISTICS_API_BASE_URL=http://tse-10-test.esiweb.pro
LOGISTICS_API_KEY=votre-cle-api
LOGISTICS_API_FOLDER=esigescom
  • LOGISTICS_API_BASE_URL : URL de base du serveur Logistics
  • LOGISTICS_API_KEY : Clé API transmise via le header X-API-KEY
  • LOGISTICS_API_FOLDER : Nom du dossier (en minuscules) utilisé dans les routes de l'API

Démarrage

npm run build

L'application est disponible à l'adresse http://api-logistics.test.

Le dashboard Filament est accessible à l'adresse http://api-logistics.test/admin.

Structure du dashboard

Le dashboard Filament propose les pages suivantes :

  • Documentation : Documentation de l'API Logistics
  • Tables : Explorer les tables disponibles dans l'API et visualiser leurs colonnes
  • Articles : Rechercher des articles et vérifier le stock
  • Documents : Lister des documents et consulter leurs détails
  • Journaux : Rechercher et lister les journaux
  • Tiers : Rechercher des tiers et consulter l'historique des articles

Architecture technique

  • config/logistics.php : Configuration de l'API Logistics
  • app/Services/LogisticsService.php : Service centralisé pour les appels HTTP vers l'API
  • app/Filament/Pages/ : Pages Filament du dashboard
  • database/migrations/ : Migrations incluant la table api_request_logs pour le suivi des requêtes

Documentation de l'API

Tests

php artisan test --compact

Formatage du code

vendor/bin/pint