2021-06-26 17:23:15 +02:00
|
|
|
<?php
|
|
|
|
|
2023-05-17 18:56:55 +02:00
|
|
|
namespace BookStack\Api;
|
2020-01-12 17:25:14 +01:00
|
|
|
|
2023-05-18 21:53:39 +02:00
|
|
|
use BookStack\Http\ApiController;
|
2020-01-12 17:25:14 +01:00
|
|
|
|
|
|
|
class ApiDocsController extends ApiController
|
|
|
|
{
|
|
|
|
/**
|
|
|
|
* Load the docs page for the API.
|
|
|
|
*/
|
|
|
|
public function display()
|
|
|
|
{
|
2020-11-21 18:03:24 +01:00
|
|
|
$docs = ApiDocsGenerator::generateConsideringCache();
|
|
|
|
$this->setPageTitle(trans('settings.users_api_tokens_docs'));
|
2021-06-26 17:23:15 +02:00
|
|
|
|
2020-01-15 21:18:02 +01:00
|
|
|
return view('api-docs.index', [
|
|
|
|
'docs' => $docs,
|
|
|
|
]);
|
2020-01-12 17:25:14 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Show a JSON view of the API docs data.
|
|
|
|
*/
|
2020-11-21 18:03:24 +01:00
|
|
|
public function json()
|
2020-01-12 17:25:14 +01:00
|
|
|
{
|
2020-11-21 18:03:24 +01:00
|
|
|
$docs = ApiDocsGenerator::generateConsideringCache();
|
2021-06-26 17:23:15 +02:00
|
|
|
|
2020-11-21 18:03:24 +01:00
|
|
|
return response()->json($docs);
|
2020-01-12 17:25:14 +01:00
|
|
|
}
|
2023-05-29 15:41:59 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Redirect to the API docs page.
|
2023-10-18 18:53:58 +02:00
|
|
|
* Required as a controller method, instead of the Route::redirect helper,
|
|
|
|
* to ensure the URL is generated correctly.
|
2023-05-29 15:41:59 +02:00
|
|
|
*/
|
|
|
|
public function redirect()
|
|
|
|
{
|
|
|
|
return redirect('/api/docs');
|
|
|
|
}
|
2020-01-12 17:25:14 +01:00
|
|
|
}
|