BookStackApp/BookStack

<?php

namespace BookStack\Api;

use BookStack\Http\ApiController;

class ApiDocsController extends ApiController
{
    /**
     * Load the docs page for the API.
     */
    public function display()
    {
        $docs = ApiDocsGenerator::generateConsideringCache();
        $this->setPageTitle(trans('settings.users_api_tokens_docs'));

        return view('api-docs.index', [
            'docs' => $docs,
        ]);
    }

    /**
     * Show a JSON view of the API docs data.
     */
    public function json()
    {
        $docs = ApiDocsGenerator::generateConsideringCache();

        return response()->json($docs);
    }

    /**
     * Redirect to the API docs page.
     *  Required as a controller method, instead of the Route::redirect helper,
     *  to ensure the URL is generated correctly.
     */
    public function redirect()
    {
        return redirect('/api/docs');
    }
}