logauth
/
SMMP
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

updated documentationDefault/apiBlueprint

This commit is contained in:
xdrm-brackets 2017-11-09 10:06:43 +01:00
parent 0a3d4d9a0a
commit ed771b20a9
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
build/api/module/module.php → build/api/module/documentationDefault.php
View File

@ -5,7 +5,7 @@
use \error\core\Err; use \error\core\Err;
use \manager\ResourceDispatcher; use \manager\ResourceDispatcher;
class module{ class documentationDefault{
public function __construct(){} public function __construct(){}
public function __destruct(){} public function __destruct(){}
@ -87,7 +87,7 @@
/* [0] Récupération de la configuration /* [0] Récupération de la configuration
=========================================================*/ =========================================================*/
// On récupère le fichier et on le parse // On récupère le fichier et on le parse
$modules = json_decode( file_get_contents(__ROOT__/'/config/modules.json'), true ); $modules = json_decode( file_get_contents(__CONFIG__.'/modules.json'), true );
// Gestion de l'erreur de parsage // Gestion de l'erreur de parsage
if( $modules == null ) if( $modules == null )
@ -185,8 +185,9 @@
/* (1) Description */ /* (1) Description */
$content .= "### $methName [POST /$module/$methName]\n\n"; $content .= "### $methName [POST /$module/$methName]\n\n";
$content .= $method['description']."\n"; $content .= $method['description']."\n";
if( count($method['permissions']) > 0) if( count($method['permissions']) > 0 )
$content .= '> Permissions `'.implode('``', $method['permissions'])."`\n\n"; foreach($method['permissions'] as $perm_set)
$content .= '> Permissions `'.implode('``', $perm_set)."`\n\n";
// Liste des paramètres // Liste des paramètres
if( isset($method['parameters']) && count($method['parameters']) > 0 ){ if( isset($method['parameters']) && count($method['parameters']) > 0 ){
@ -194,7 +195,7 @@
$content .= "+ Parameters\n\n"; $content .= "+ Parameters\n\n";
foreach($method['parameters'] as $argName=>$argument){ foreach($method['parameters'] as $argName=>$argument){
$optional = isset($argument['optional']) && $argument['optional'] === true; $optional = isset($argument['optional']) && $argument['optional'] === true;
$content .= " + $argName (${argument['type']}, ".( $optional ? 'optional' : 'required' ).") - ${argument['description']}\n"; $content .= " + $argName (".$argument['type'].", ".( $optional ? 'optional' : 'required' ).") - ".(isset($argument['description']) ? $argument['description'] : 'none')."\n";
} }
$content .= "\n"; $content .= "\n";
} }
@ -252,7 +253,7 @@
// On explicite tous les paramètres // On explicite tous les paramètres
$content .= " + Attributes (object)\n\n"; $content .= " + Attributes (object)\n\n";
foreach($method['output'] as $outName=>$outData) foreach($method['output'] as $outName=>$outData)
$content .= " + $outName (${outData['type']}) - ${outData['description']}\n"; $content .= " + $outName (".$outData['type'].") - ".(isset($outData['description']) ? $outData['description'] : 'none')."\n";
} }
$content .= "\n\n"; $content .= "\n\n";

2
config/modules.json
View File

@ -1,6 +1,6 @@
{ {
"module": { "documentationDefault": {
"POST::apiBlueprint": { "POST::apiBlueprint": {
"description": "Retourne une documentation de l'API au format API Blueprint.", "description": "Retourne une documentation de l'API au format API Blueprint.",