1. Go to this page and download the library: Download chxj1992/php-apidoc library. Choose the download type require.
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
chxj1992 / php-apidoc example snippets
namespace Some\Namespace;
class User
{
/**
* @ApiDescription(section="User", description="Get information about user")
* @ApiMethod(type="get")
* @ApiRoute(name="/user/get/{id}")
* @ApiParams(name="id", type="integer", nullable=false, description="User id")
* @ApiParams(name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}")
* @ApiReturnHeaders(sample="HTTP 200 OK")
* @ApiReturn(type="object", sample="{
* 'transaction_id':'int',
* 'transaction_status':'string'
* }")
*/
public function get()
{
}
/**
* @ApiDescription(section="User", description="Create's a new user")
* @ApiMethod(type="post")
* @ApiRoute(name="/user/create")
* @ApiParams(name="username", type="string", nullable=false, description="Username")
* @ApiParams(name="email", type="string", nullable=false, description="Email")
* @ApiParams(name="password", type="string", nullable=false, description="Password")
* @ApiParams(name="age", type="integer", nullable=true, description="Age")
*/
public function create()
{
}
}
# apidoc.php
use Crada\Apidoc\Builder;
use Crada\Apidoc\Exception;
$classes = array(
'Some\Namespace\User',
'Some\Namespace\OtherClass',
);
$output_dir = __DIR__.'/apidocs';
$output_file = 'api.html'; // defaults to index.html
try {
$builder = new Builder($classes, $output_dir, 'Api Title', $output_file);
$builder->generate();
} catch (Exception $e) {
echo 'There was an error generating the documentation: ', $e->getMessage();
}