<?php namespace BookStack\Api;
use BookStack\Http\Controllers\Api\ApiController;
+use Illuminate\Contracts\Container\BindingResolutionException;
use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Route;
+use Illuminate\Support\Str;
use ReflectionClass;
use ReflectionException;
use ReflectionMethod;
protected $reflectionClasses = [];
protected $controllerClasses = [];
+ /**
+ * Load the docs form the cache if existing
+ * otherwise generate and store in the cache.
+ */
+ public static function generateConsideringCache(): Collection
+ {
+ $appVersion = trim(file_get_contents(base_path('version')));
+ $cacheKey = 'api-docs::' . $appVersion;
+ if (Cache::has($cacheKey) && config('app.env') === 'production') {
+ $docs = Cache::get($cacheKey);
+ } else {
+ $docs = (new static())->generate();
+ Cache::put($cacheKey, $docs, 60 * 24);
+ }
+ return $docs;
+ }
+
/**
* Generate API documentation.
*/
- public function generate(): Collection
+ protected function generate(): Collection
{
$apiRoutes = $this->getFlatApiRoutes();
$apiRoutes = $this->loadDetailsFromControllers($apiRoutes);
/**
* Load body params and their rules by inspecting the given class and method name.
- * @throws \Illuminate\Contracts\Container\BindingResolutionException
+ * @throws BindingResolutionException
*/
protected function getBodyParamsFromClass(string $className, string $methodName): ?array
{
'method' => $route->methods[0],
'controller' => $controller,
'controller_method' => $controllerMethod,
+ 'controller_method_kebab' => Str::kebab($controllerMethod),
'base_model' => $baseModelName,
];
});
}
-
-}
\ No newline at end of file
+}