Syntax d\'un fichier route
Le fichier route doit être nommé web.routes.php et doit être placé à la racine du controlleur concerné.
'; $html.="Voir la syntaxe
return [
// nom de l'API et préfixe de l'URL, est unique au système
'api'=>'apiname'
// namespace de la classe publique
,'class'=>'public\\class\\namespace'
// Les possibles restrictions d'accès au groupe de route (FACULTATIF). Tous les routes de tous les types seront restreint par les accès utilisateur
// Restrictions possibles :
// - sys_admin : administrateur système
// - admin : administrateur client
,'restrictions'=>['sys_admin','admin']
// Les routes GET (pour l'obtention de donnée)
,'get'=>[
[
// Description de la route
'desc'=>'La description détaillée de la route',
// Les possibles restrictions d'accès à la route (FACULTATIF). La route sera restreinte par les accès utilisateur
// Restrictions possibles :
// - sys_admin : administrateur système
// - admin : administrateur client
,'restrictions'=>['sys_admin','admin']
// Reste de l'URL
'url'=>'{dynamicparam}/path/to/something'
// méthode de la classe publique que ça atteindra
,'method'=>'methodName'
// paramètres dynamiques du path de l'URL, et l'expression régulière de contrôle du paramètre
,'params'=>[
'dynamicparam' =>'[PCRE REGEX]',
]
// description des paramètres dynamiques du path de l'URL
,'params_desc'=>[
'dynamicparam' =>'Un paramètre dynamique'
]
// paramètres requis de l'URL (ie mon/url?param=paramvalue)
,'get_params'=>[
'param' =>'[PCRE REGEX]'
]
// paramètres facultatifs de l'URL
,'opt_get_params'=>[
'param2' =>'[PCRE REGEX]'
]
// description des paramètres de l'URL
,'get_params_desc'=>[
'param' =>'description de param',
'param2' =>'description de param2'
]
],
]
// Les routes POST (pour la création d'éléments uniquement)
,'post'=>[
[
// Description de la route
'desc'=>'La description détaillée de la route',
// Les possibles restrictions d'accès à la route (FACULTATIF). La route sera restreinte par les accès utilisateur
// Restrictions possibles :
// - sys_admin : administrateur système
// - admin : administrateur client
,'restrictions'=>['sys_admin','admin']
// Reste de l'URL
'url'=>'{dynamicparam}/path/to/something'
// méthode de la classe publique que ça atteindra
,'method'=>'methodName'
// paramètres dynamiques du path de l'URL, et l'expression régulière de contrôle du paramètre
,'params'=>[
'dynamicparam' =>'[PCRE REGEX]',
]
// description des paramètres dynamiques du path de l'URL
,'params_desc'=>[
'dynamicparam' =>'Un paramètre dynamique'
]
// Paramètre du POST
,'post_params'=>[
'param' =>'[PCRE REGEX ou \"JSON\"]',
'jsonex' =>'[PCRE REGEX ou \"JSON\"]',
]
// Paramètres optionnels du POST
,'opt_post_params'=>[
'param2' =>'[PCRE REGEX ou \"JSON\"]'
]
// description des paramètres du POST
,'post_params_desc'=>[
'param' =>'description de param',
'param2' =>'description de param2',
'jsonex' =>'Un tableau PHP représentant l\'objet JSON',
]
],
]
// Les routes PATCH (pour la mise à jour d'éléments uniquement)
,'patch'=>[
[
// Description de la route
'desc'=>'La description détaillée de la route',
// Les possibles restrictions d'accès à la route (FACULTATIF). La route sera restreinte par les accès utilisateur
// Restrictions possibles :
// - sys_admin : administrateur système
// - admin : administrateur client
,'restrictions'=>['sys_admin','admin']
// Reste de l'URL
'url'=>'{dynamicparam}/path/to/something'
// méthode de la classe publique que ça atteindra
,'method'=>'methodName'
// paramètres dynamiques du path de l'URL, et l'expression régulière de contrôle du paramètre
,'params'=>[
'dynamicparam' =>'[PCRE REGEX ou \"JSON\"]',
]
// description des paramètres dynamiques du path de l'URL
,'params_desc'=>[
'dynamicparam' =>'Un paramètre dynamique'
]
// Paramètre du PATCH
,'post_params'=>[
'param' =>'[PCRE REGEX]'
]
// Paramètres optionnels du PATCH
,'opt_post_params'=>[
'param2' =>'[PCRE REGEX ou \"JSON\"]'
'jsonex' =>'[PCRE REGEX ou \"JSON\"]',
]
// description des paramètres du PATCH
,'post_params_desc'=>[
'param' =>'description de param',
'param2' =>'description de param2'
'jsonex' =>'Un tableau PHP représentant l\'objet JSON',
]
],
]
// Les routes DELETE (pour la suppression d'éléments uniquement)
,'delete'=>[
[
// Description de la route
'desc'=>'La description détaillée de la route',
// Les possibles restrictions d'accès à la route (FACULTATIF). La route sera restreinte par les accès utilisateur
// Restrictions possibles :
// - sys_admin : administrateur système
// - admin : administrateur client
,'restrictions'=>['sys_admin','admin']
// Reste de l'URL
'url'=>'{dynamicparam}/path/to/something'
// méthode de la classe publique que ça atteindra
,'method'=>'methodName'
// paramètres dynamiques du path de l'URL, et l'expression régulière de contrôle du paramètre
,'params'=>[
'dynamicparam' =>'[PCRE REGEX]',
]
// description des paramètres dynamiques du path de l'URL
,'params_desc'=>[
'dynamicparam' =>'Un paramètre dynamique'
]
// Paramètre du DELETE
,'post_params'=>[
'param' =>'[PCRE REGEX]'
]
// Paramètres optionnels du DELETE
,'opt_post_params'=>[
'param2' =>'[PCRE REGEX]'
]
// description des paramètres du DELETE
,'post_params_desc'=>[
'param' =>'description de param',
'param2' =>'description de param2'
]
],
]
];