module/apiBlueprint retourne le fichier complet
This commit is contained in:
xdrm-brackets
parent
bb696c6cac
commit
21577552d9
|
|
@ -1,6 +1,9 @@
|
|||
<?php define('__ROOT__', dirname(__FILE__) );
|
||||
require_once __ROOT__.'/manager/autoloader.php';
|
||||
|
||||
|
||||
|
||||
|
||||
use \manager\ModuleRequest;
|
||||
use \manager\ResourceDispatcher;
|
||||
use \manager\sessionManager;
|
||||
|
|
|
|||
|
|
@ -94,7 +94,7 @@
|
|||
*
|
||||
*/
|
||||
public static function apiBlueprint(){
|
||||
/* [1] Récupération de la configuration
|
||||
/* [0] Récupération de la configuration
|
||||
=========================================================*/
|
||||
// On récupère le fichier et on le parse
|
||||
$modules = json_decode( ResourceDispatcher::getResource('f/json/modules/conf'), true );
|
||||
|
|
@ -104,10 +104,88 @@
|
|||
return array( 'ModuleError' => ManagerError::ParsingFailed );
|
||||
|
||||
|
||||
/* [1] Début du fichier custom
|
||||
=========================================================*/
|
||||
$content = "FORMAT: 1A\n";
|
||||
$content .= "HOST: https://socioview.xdrm.io/api/\n\n";
|
||||
|
||||
$content .= "# NxTIC API\n";
|
||||
$content .= "API de la plateforme d'étude **NxTIC**, cette documentation présentera toutes les méthodes accessibles depuis la plateforme elle-même et depuis un logiciel tiers.\n";
|
||||
$content .= "La plateforme **NxTIC** est une plateforme d'étude sociale développé par Adrien Marquès _(xdrm-brackets)_ pour un laboratoire de sociologie du _CNRS_.\n";
|
||||
$content .= "Elle a pour objectif l'acquisition, la visualisation et l'extraction de données relationnelles.\n";
|
||||
$content .= "> Cette plateforme est temporairement hébergée sur https://socioview.xdrm.io/.\n";
|
||||
|
||||
|
||||
$content .= "## Structure et fonctionnement\n";
|
||||
$content .= "Le fonctionnement est basé sur une délégation à 2 niveaux : des __modules__ contenant des __méthodes__.\n\n";
|
||||
|
||||
$content .= "***\n";
|
||||
|
||||
|
||||
$content .= "### Paramètres\n";
|
||||
$content .= "Tous les paramètres doivent être envoyés en `multipart/form-data`.\n\n";
|
||||
|
||||
$content .= "1. Chacun formatté en `json` \n";
|
||||
$content .= "2. Portant le `nom` défini dans la documentation \n";
|
||||
$content .= "3. L'ordre n'a pas d'importance \n";
|
||||
$content .= "4. Respectant le `type` défini dans la documentation (cf. [Types](#introduction/types-de-donnees)) \n\n";
|
||||
|
||||
$content .= "> **Note:** Les `paramètres URI` ne correspondent pas aux paramètres URI. \n";
|
||||
$content .= "Ils servent à expliciter les paramètres et leurs types, et correspondent aux variables notées `{nomVar}` dans le corps de la requête.\n";
|
||||
|
||||
|
||||
$content .= "### Réponses\n\n";
|
||||
|
||||
$content .= "#### A. Les réponses seront formattées en json et contiendront:\n\n";
|
||||
|
||||
$content .= "1. `ModuleError` - Le code de l'erreur \n";
|
||||
$content .= "2. `ErrorDescription` - La description de l'erreur\n\n";
|
||||
|
||||
$content .= "****\n\n";
|
||||
|
||||
$content .= "#### B. Codes `HTTP` et leur signification.\n\n";
|
||||
|
||||
$content .= "|Status|Code HTTP|\n";
|
||||
$content .= "|---|---|\n";
|
||||
$content .= "|OK|`200` - Success|\n";
|
||||
$content .= "|Erreur|`417` - Erreur quelconque|\n";
|
||||
|
||||
|
||||
|
||||
$content .= "## Types de données\n\n";
|
||||
|
||||
$content .= "### Types Simples \n";
|
||||
$content .= "|Type|Exemple|Description|\n";
|
||||
$content .= "|---|---|---|\n";
|
||||
$content .= "|`mixed`|`[9,\"a\"]`, `\"a\"`|Type quelconque (peut être simple ou composé)|\n";
|
||||
$content .= "|`id`|`10`, `\"23\"`|Nombre entier positif compris entre `0` et `2147483647`|\n";
|
||||
$content .= "|`text`|`\"Hello!\"`|Chaine de caractères de longueur quelconque (peut être vide)|\n";
|
||||
$content .= "|`mail`|`\"a.b@c.def\"`|Adresse mail avec une syntaxe valide|\n";
|
||||
$content .= "|`number`|`0102030405`|Numéro de téléphone valide suivant les formats : `06`, `+336`, `+33 6`|\n";
|
||||
$content .= "|`array`|`[1, 3]`|Tableau quelconque non vide|\n";
|
||||
$content .= "|`boolean`|`true`, `false`|Booléen|\n";
|
||||
$content .= "|`varchar(a,b)`|`\"Hello!\"`|Chaine de caractères de taille comprise entre `a` et `b` (inclus)|\n";
|
||||
|
||||
|
||||
$content .= "### Type composé : array\n\n";
|
||||
|
||||
$content .= "|Type|Sous-Type|Description|\n";
|
||||
$content .= "|---|---|---|\n";
|
||||
$content .= "|`array<mixed>`|`mixed`|Tableau contenant uniquement des données de type `mixed`|\n";
|
||||
$content .= "|`array<id>`|`id`|Tableau contenant uniquement des données de type `id`|\n";
|
||||
$content .= "|`array<text>`|`text`|Tableau contenant uniquement des données de type `text`|\n";
|
||||
$content .= "|`array<mail>`|`mail`|Tableau contenant uniquement des données de type `mail`|\n";
|
||||
$content .= "|`array<number>`|`number`|Tableau contenant uniquement des données de type `number`|\n";
|
||||
$content .= "|`array<array>`|`array`|Tableau contenant uniquement des données de type `array`|\n";
|
||||
$content .= "|`array<boolean>`|`boolean`|Tableau contenant uniquement des données de type `boolean`|\n";
|
||||
$content .= "|`array<varchar(a,b)>`|`varchar(a,b)`|Tableau contenant uniquement des données de type `varchar(a,b)`|\n\n";
|
||||
|
||||
$content .= "> **Note:** Il est possible de chainer le type `array` autant de fois que nécessaire. \n";
|
||||
$content .= "**Ex.:** `array<array<id>>` - Soit un tableau contenant des tableaux contenant exclusivement des données de type `id`.\n";
|
||||
|
||||
|
||||
/* [2] Pour chaque module
|
||||
=========================================================*/
|
||||
$content = '';
|
||||
foreach($modules as $module=>$methods){
|
||||
|
||||
$content .= "## $module [/$module] \n\n";
|
||||
|
|
|
|||
Loading…
Reference in New Issue