https://github.com/patrickjaja/php-xsd-to-documentation-generator
https://github.com/patrickjaja/php-xsd-to-documentation-generator
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/patrickjaja/php-xsd-to-documentation-generator
- Owner: patrickjaja
- Created: 2015-12-27T22:29:04.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-27T23:02:54.000Z (over 10 years ago)
- Last Synced: 2025-08-16T23:55:40.815Z (10 months ago)
- Language: HTML
- Size: 8.68 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Dynamic generate a responsive documentation by using XSD webservice description files
# Features
- Use and generate a documentation "on the fly"
- Multilang
- Responsive
- Easy to customize
- Searchable, and structured
- Including one example Theme (see gif)
# Live Example to commited Test XSD Files
# How to
- Clone Repo
- place in your XSD files
- check gui.load.php and insert your configurations
# XSD Example to decribe your application interfaces
```
Klasse benötigt für die Fahrer.
Class used for Drivers
Laden von Fahrern.
load of Drivers
ID des spaau href="#fnsimpleuser_insert">Benutzers(Fahrer) spazu aus der Datenbank z.B. 1.
ID of the spaau href="#fnsimpleuser_insert">User(Driver) spazu from the database for example 1.
löschen von Fahrer.
delete of Drivers
Aktualisieren von Fahrer.
update of Drivers
Einfügen von Fahrern.
insert of Drivers
```
# XSD parser for example file (used in gui.load.php)
```
$generator=new APIProcessor("img/logo.png","lang/","xsd/");
$generator->apiVersion="1.9.0";
$generator->keywords=array("json"
,"xml"
,"true"
,"format"
,"parse json"
,"yes");
$generator->links=array("skey"=>"http://example.de"
,"token"=>"http://example.de"
,"API Call"=>"http://example.de"
,"format"=>"http://example.de"
,"lang"=>"http://example.de#lang"
,"NEW_ORDERS_DELIVERY_PUFFER"=>"http://example.de#generaltrace2Parameter");
// $generator->replaceIcon=array("##warn##"=>"http://example.de/ico.png");
// $generator->highlight=array("muss");
$page=$dom["theme1"]["page"];
// //Baue Head
// $code="";
// $menuitem=$dom["theme1"]["group_navi_elem"];
// foreach($this->groups as $key=>$elem) {
// $code.=str_replace(array("##GROUPID##","##GROUPNAME##"),array($key,""),$menuitem);
// }
//
// $dom=str_replace('##GROUPNAVI##', $code, $page);
//
// STAMMDATENFUNCTIONS
$this->groups["##STAMMDATEN##"]=array("class.fnDrivers"
,"class.fnAuftraege"
,"class.fnAupos"
,"class.fnUpos"
,"class.fnCustomer"
,"class.fnTour"
,"class.fnDrawings"
,"class.fnServiceHinweise"
,"class.fnServiceRythm"
,"class.fnCat"
);
$this->groups["##ERGEBNISSE##"]=array("class.fnFleetPositions"
,"class.fnFleetEvents"
,"class.fnFleetTourActivity"
);
$this->groups["##EINSTELLUNGEN##"]=array("class.fnTourAssignments"
,"class.fnDriver2Tour"
,"class.fnAndroidConfiguration"
,"class.fnCustomTour"
,"class.fnImports"
);
$systemURL="https://be.trace2.de/trace2/service.php";
$systemName="trace2";
$systemDefaultParams="&format=json";
$xsdArray=$generator->getResults();
```
ToDo:
- Backend is coded in PHP but the framework is not open source (so we need a new backend)
- structured milestones and task group definitions
- exclude the project definitions out of gui.load.php to a project config file
- get a filehoster for this project to provide a better demo