Documentation API

La documentation pour les API permet l'intégration de l'application aux systèmes d'information en développant des logiciels clients.

Elle se compose de deux parties principales :

• les chemins décrivent les routes d'accès aux ressources,
• les définitions fournissent la structure des données échangées

Maarch est désormais compatible openApi. Pour générer dynamiquement la documentation de l'API, rendez-vous sur la page de démarrage de votre solution (usuellement maarchrm) et rajouter l'url openapi.html ou openapi.json (ce qui donnera maarchrm/openapi.html pour une mise en page améliorée, et maarchrm/openapi.json pour une mise en page simple). Vous pouvez également vous rendre sur https://editor.swagger.io/ pour avoir une mise en page générée automatiquement.