dwolf555/api-docs-controller

v1.1 2014-01-10 17:11 UTC

Requires

• php: >=5.4.0
• illuminate/support: 4.1.*

MIT

• Daniel Wolf

README

Laravel controller class that allows for output of API docs if the "accept" header is not set to json.

Set up

Add the following to your composer.json and composer update / composer install

{
    "require": {
        "dwolf555/api-docs-controller": "dev-master"
    }
}

Add the following to your app/config/app.php providers array

'Dwolf555\ApiDocsController\ApiDocsControllerServiceProvider',

Example Controller

class UserController extends Dwolf555\ApiDocsController\ApiDocsController {

    /**
     * Display a listing of the resource.
     *
     * @return Response
     */
    public function index()
    {
        // For documentation
        $this->apiDocInfo = [
            'wordOfWarning' => 'Just be ok, ok?',
            'exampleResponse' => ['message' => 'ok'],
            'inputs' => [
                'limit' => 10,
                'offset' => 0
            ],
            'possibleErrors' => [
                'limit' => 'Limit must be a valid integer.',
                'offset' => 'Limit must be a valid integer.',
            ]
        ];

        $content = array(
            'actualcontent' => 'realstuff'
        );
        $statusCode = 200;

        return $this->generateResponse($content, $statusCode);
    }

}

Example Output