Jérémy Munsch
0d2b0124ee
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
2.1 KiB
2.1 KiB
Arcadia API
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).
📚 Documentation pour les Développeurs
L'ensemble de la documentation technique et des guides pratiques est organisé dans le dossier documentation/ :
🏛️ Architecture & Fonctionnement
- 01 - Architecture Globale : 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) : Traçage pas-à-pas d'une requête HTTP depuis la route jusqu'à la sérialisation JSON.
- 03 - Exécution, Transactions & Événements :
UsecaseBuilder,LaravelExecutor, exécution transactionnelle et dispatch sécurisé post-commit (TransactionalDomainEventDispatcher). - 04 - Guide Nouveau Cas d'Usage : Checklist pas-à-pas pour créer une nouvelle fonctionnalité de bout en bout.
📐 Conventions & Standards
- Conventions de Tests : Principes F.I.R.S.T., structure GWT, pyramide de tests, Test Data Builders et Object Mothers.
- Gestion des Exceptions : Matrice de correspondance entre exceptions applicatives/domaine et codes HTTP RFC 7807 (400, 404, 409, 422, 429, 500).
🚀 Commandes Utiles
# Lancer la suite de tests Pest
composer test
# Lancer l'analyse statique PHPStan (Niveau 10)
vendor/bin/phpstan analyse
# Vérifier le formattage du code PSR-12 (Pint)
vendor/bin/pint --test
# Verifier les conventions et regles de lint (PHP Code Sniffer)
vendor/bin/phpcs
# Corriger automatiquement les conventiosn (PHP Code Beautifier)
vendor/bin/phpcbf