CDPP / AMDA_IHM

Commit ff01af8db045d50007df5b4d0639bba3b6e605ac

Authored by Nathanaël Jourdane
1 parent 55748a3e
Exists in master and in 108 other branches 10098, 10178, 5390, 6629, 6728, 6920, 7494, 7497, 7616, 8459, 8528, 8928, 9014, 9016Bis, 9017, 9049, 9084, 9259, 9326, 9345, 9505, 9660, 9750, 9750.bck, 9800, 9980, FER_10285, FER_10400, FER_10435, FER_10557, FER_10663, FER_10765, FER_10828, FER_10828_2, FER_10829, FER_10836, FER_10852, FER_10934, FER_11100, FER_11242, FER_11478, FER_11500, FER_11537, FER_11586, FER_11588, FER_5119, FER_5165, FER_6265, FER_6860, FER_6899, FER_6951, FER_7618, FER_7862, FER_8455, FER_9629, FER_9660, FER_9915, FER_CR41, FER_CR42, FER_CR43, FER_TFCat, Histo1D2D, MAZ_10936, MAZ_11362, MAZ_11427, MAZ_6018, MAZ_9016_New, MAZ_FIX_9016, New_ColorMaps, SpeasyGet, alias, amdadev, amdadev_test, anr_tempete, catalog-histo, create-user, cu2022, density_maps, develop, epn-tap, expression-parser-bre, frames-transformation, hapi, homePage, master_vge, minimize, mlplasmas, multiplot, new-save-plot-request, openam, plot-request, plot-request-update, plot-tt-catalog, remoteData, rm_5118, rm_5776, rm_6912, rm_6912_bis, rm_7926, rm_8932, save-other-requests, save-plot, save-plot-request, shared-objects-updater, special-params, sum-components-indexes, test-merge, ws_get_catalog

Add script to generate the API documentation

Showing 3 changed files with 16 additions and 2 deletions   Show diff stats
Inline Side-by-side
php/my_config.template.php
  Diff comments   View file @ff01af8
... ... @@ -32,4 +32,6 @@ define('NEWMETA', '{:NEWMETA:}');
32 32 define('AMDA_SPASE_INTERFACE', '{:AMDA_SPASE_INTERFACE:}');
33 33 define('AMDAINTERNALDIR', '{:AMDAINTERNALDIR:}');
34 34  
  35 +define('REST_API_URL', '{:REST_API_URL:}');
  36 +define('API_DOC_PATH', '{:API_DOC_PATH:}');
35 37 ?>
... ...
php/rest/apidoc.json
  Diff comments   View file @ff01af8
... ... @@ -2,6 +2,6 @@
2 2 "name": "AMDA web-services Rest API",
3 3 "description": "The web-services provided by AMDA aim at giving to a user access public data as well as its private data. These data may be private or shared Time Tables, public or user-defined parameters. All these webservices are also available through a SOAP interface.",
4 4 "title": "AMDA Web-services Rest API documentation",
5   - "url": "http://amda.irap.omp.eu/php/rest/",
6   - "sampleUrl": "http://amda.irap.omp.eu/php/rest/"
  5 + "url": "{:REST_API_URL:}/php/rest/",
  6 + "sampleUrl": "{:REST_API_URL:}/php/rest/"
7 7 }
... ...
scripts/apiDoc.php 0 → 100644
  Diff comments   View file @ff01af8
... ... @@ -0,0 +1,12 @@
  1 +<?php
  2 +require_once dirname(__FILE__) . '/../php/config.php';
  3 +
  4 +$restFolderPath = AMDA_IHM . "php/rest";
  5 +$apidocConfigFile = $restFolderPath . "apidoc.json";
  6 +$tempConfigFile = tempnam(sys_get_temp_dir(), 'apidoc.json');
  7 +
  8 +$apidocConfig = str_replace("{:REST_API_URL:}", REST_API_URL, file_get_contents($apidocConfigFile));
  9 +file_put_contents($tempConfigFile, $apidocConfig);
  10 +
  11 +echo exec("apidoc -v -c $tempConfigFile -i $restFolderPath -o " . API_DOC_PATH);
  12 +?>
... ...