BookStack Code Mirror - bookstack/blob - app/Api/ApiDocsController.php

   1 <?php
   2
   3 namespace BookStack\Api;
   4
   5 use BookStack\Http\ApiController;
   6
   7 class ApiDocsController extends ApiController
   8 {
   9     /**
  10      * Load the docs page for the API.
  11      */
  12     public function display()
  13     {
  14         $docs = ApiDocsGenerator::generateConsideringCache();
  15         $this->setPageTitle(trans('settings.users_api_tokens_docs'));
  16
  17         return view('api-docs.index', [
  18             'docs' => $docs,
  19         ]);
  20     }
  21
  22     /**
  23      * Show a JSON view of the API docs data.
  24      */
  25     public function json()
  26     {
  27         $docs = ApiDocsGenerator::generateConsideringCache();
  28
  29         return response()->json($docs);
  30     }
  31
  32     /**
  33      * Redirect to the API docs page.
  34      *  Required as a controller method, instead of the Route::redirect helper,
  35      *  to ensure the URL is generated correctly.
  36      */
  37     public function redirect()
  38     {
  39         return redirect('/api/docs');
  40     }
  41 }