2.2.3) Requests: GET Documentation

Documentation

PS: Work only with pgsql and mysql database type at the moment

For get auto-documentation of a database table:

• Documentation index URL format : /[database]/docs/index.[format]

• Documentation index URL format with Authentication: /[token]/[database]/docs/index.[format]

• Documentation URL format: /[database]/docs/[table].[format]

• Documentation URL format with Authentication: /[token]/[database]/docs/[table].[format]

For have a separated file where document your database you can use /docs.php

Example

<?php

$docs = array(
    'dataset' => array(
        "example" => array(
            "id" => array(
                "description" => "Row identification",
                "example" => "1",
            ),
            "guid" => array(
                "description" => "Standard row identification GUID",
                "example" => "cc7c0e6f-2662-8451-1e70-5c61496c3f5f",
            ),
        ),
    )
);