BookStack/app/Api/ApiDocsController.php

42 lines
900 B
PHP
Raw Normal View History

2021-06-26 23:23:15 +08:00
<?php
2023-05-18 00:56:55 +08:00
namespace BookStack\Api;
2020-01-13 00:25:14 +08:00
use BookStack\Http\ApiController;
2020-01-13 00:25:14 +08:00
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'));
2021-06-26 23:23:15 +08:00
2020-01-16 04:18:02 +08:00
return view('api-docs.index', [
'docs' => $docs,
]);
2020-01-13 00:25:14 +08:00
}
/**
* Show a JSON view of the API docs data.
*/
public function json()
2020-01-13 00:25:14 +08:00
{
$docs = ApiDocsGenerator::generateConsideringCache();
2021-06-26 23:23:15 +08:00
return response()->json($docs);
2020-01-13 00:25:14 +08:00
}
/**
* 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');
}
2020-01-13 00:25:14 +08:00
}