forge-joniko/ldc-arcadia-api
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ldc-arcadia-api/README.md

77 lines
3.3 KiB
Markdown
Raw Normal View History

docs(README): update API description and architecture details Added detailed architecture sections and principles of implementation to the README.
2026-08-12 17:00:48 +02:00
# Arcadia API
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
**Arcadia API** est une API de référence conçue selon les principes de la **Clean Architecture**, du **Domain-Driven Design (DDD)** et de l'**Architecture Hexagonale (Ports & Adapters)**.
docs(README): update table of contents and add testing section docs(TEST): add testing strategy and organization document
2026-08-13 11:50:11 +02:00
---
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
## 📚 Documentation pour les Développeurs
docs(README): update API description and architecture details Added detailed architecture sections and principles of implementation to the README.
2026-08-12 17:00:48 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
L'ensemble de la documentation technique et des guides pratiques est organisé dans le dossier [`documentation/`](documentation/) :
docs(README): update API description and architecture details Added detailed architecture sections and principles of implementation to the README.
2026-08-12 17:00:48 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
### 🏛️ Architecture & Fonctionnement
- **[01 - Architecture Globale](documentation/Architecture/01-architecture-globale.md)** : Vue d'ensemble des couches (`Domain`, `Application`, `Presentation`, `Infra`, `Shared`), responsabilités et règles de dépendances strictes.
- **[02 - Cycle de Vie d'une Requête (Bullet Tracer)](documentation/Architecture/02-cycle-de-vie-requete.md)** : Traçage pas-à-pas d'une requête HTTP depuis la route jusqu'à la sérialisation JSON.
- **[03 - Exécution, Transactions & Événements](documentation/Architecture/03-execution-et-transactions.md)** : `UsecaseBuilder`, `LaravelExecutor`, exécution transactionnelle et dispatch sécurisé post-commit (`TransactionalDomainEventDispatcher`).
- **[04 - Guide Nouveau Cas d'Usage](documentation/Architecture/04-guide-nouveau-usecase.md)** : Checklist pas-à-pas pour créer une nouvelle fonctionnalité de bout en bout.
docs: add 05-temps-et-base-de-donnees guide and update architecture documentation
2026-08-21 16:13:39 +02:00
- **[05 - Temps, Horloge PSR-20 & Base de Données](documentation/Architecture/05-temps-et-base-de-donnees.md)** : Contrat PSR-20 `Clock`, Façade `Utc`, tests avec `FrozenClock`, standardisation `DATETIME` et dérivation `created_at` depuis UUIDv7.
docs(README): update API description and architecture details Added detailed architecture sections and principles of implementation to the README.
2026-08-12 17:00:48 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
### 📐 Conventions & Standards
- **[Conventions de Tests](documentation/Conventions/tests.md)** : Principes F.I.R.S.T., structure GWT, pyramide de tests, **Test Data Builders** et **Object Mothers**.
- **[Gestion des Exceptions](documentation/Conventions/exceptions.md)** : Matrice de correspondance entre exceptions applicatives/domaine et codes HTTP RFC 7807 (400, 404, 409, 422, 429, 500).
docs(README): update API description and architecture details Added detailed architecture sections and principles of implementation to the README.
2026-08-12 17:00:48 +02:00
docs: add Oracle integration guide to README Includes reference to SQL queries and live documentation.
2026-08-26 15:32:45 +02:00
### 🗄️ Métamodèle & Intégration Oracle
- **[Métamodèle Arcadia & Intégration Oracle](documentation/Arcadia/README.md)** : Guide d'intégration, requêtes SQL de référence et pointage vers la documentation vivante (`database/arcadia-replicate/`).
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
---
docs(README): update API description and architecture details Added detailed architecture sections and principles of implementation to the README.
2026-08-12 17:00:48 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
## 🚀 Commandes Utiles
docs(README): update table of contents and add testing section docs(TEST): add testing strategy and organization document
2026-08-13 11:50:11 +02:00
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
### Développement & Qualité de Code
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
```bash
# Lancer la suite de tests Pest
composer test
docs: update README and add Exceptions documentation Added a section for Exception Management in README and created a new document detailing exception handling and HTTP status codes.
2026-08-13 12:34:12 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
# Lancer l'analyse statique PHPStan (Niveau 10)
vendor/bin/phpstan analyse
docs: update README and add Exceptions documentation Added a section for Exception Management in README and created a new document detailing exception handling and HTTP status codes.
2026-08-13 12:34:12 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
# Vérifier le formattage du code PSR-12 (Pint)
vendor/bin/pint --test
docs(README): update table of contents and add testing section docs(TEST): add testing strategy and organization document
2026-08-13 11:50:11 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
# Verifier les conventions et regles de lint (PHP Code Sniffer)
vendor/bin/phpcs
docs(README): update table of contents and add testing section docs(TEST): add testing strategy and organization document
2026-08-13 11:50:11 +02:00
docs(architecture): add global architecture documentation for Arcadia API docs(architecture): add request lifecycle documentation for Arcadia API docs(architecture): add execution, transactions, and domain events documentation for Arcadia API docs(architecture): add guide for creating a new use case in Arcadia API docs(exceptions): summarize exception handling and HTTP status codes in Arcadia API docs(tests): outline testing strategy and conventions for Arcadia API style(openapi): correct description formatting in OpenAPI documentation chore: remove outdated exceptions documentation test: remove obsolete tests documentation
2026-08-21 10:41:07 +02:00
# Corriger automatiquement les conventiosn (PHP Code Beautifier)
vendor/bin/phpcbf
```
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
### Gestion de l'Application Arcadia
```bash
# Vérifier l'état de l'application
php artisan health
# List all Arcadia brands
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:brand:list
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
# List all Arcadia clients
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:client:list
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
# Create a new Arcadia client (interactive wizard)
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:client:create
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
# Regenerate the secret of an API client
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:client:regenerate-secret
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
# Toggle the status of an API client
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:client:toggle-status
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
# Check schema and query conformity of the replicated Arcadia Oracle database
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:database:check-conformity
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
# Display or export security audit events since a specified date
docs: update README to use 'artisan' command prefix Replaced 'php arcadia:' with 'php artisan arcadia:' for consistency in command usage.
2026-08-31 11:18:28 +02:00
php artisan arcadia:security:audit-logs
docs: update README with development and application management commands Added sections for development quality commands and Arcadia application management commands.
2026-08-31 11:10:42 +02:00
```
Reference in a new issue Copy permalink