3.1-3.6: install l5-swagger, add @OA annotations to all controllers

This commit is contained in:
parsa aghaei committed 2026-06-23 18:34:20 +03:30
1 parent db7ce880a0
commit afb202f333
13 files changed
+1367 -73

No files matched your search

@@ -10,8 +10,21 @@ use App\Http\Resources\PostResource;
use App\Models\Blog\Category;
use Illuminate\Http\Request;
/**
* @OA\Tag(name="Categories", description="Blog categories")
*/
class CategoryController extends Controller
{
/**
* @OA\Get(
* path="/blog/categories",
* tags={"Categories"},
* summary="Paginated list of categories",
* @OA\Parameter(name="per_page", in="query", @OA\Schema(type="integer")),
* @OA\Parameter(name="filter", in="query", @OA\Schema(type="string")),
* @OA\Response(response=200, description="OK")
* )
*/
public function index(Request $request)
{
$filter = $request->input('filter');
@@ -32,12 +45,32 @@ class CategoryController extends Controller
return CategoryResource::collection($categories);
}
/**
* @OA\Get(
* path="/blog/categories/{id}",
* tags={"Categories"},
* summary="Get a category by ID",
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
* @OA\Response(response=200, description="OK")
* )
*/
public function show($id)
{
$category = Category::with('posts')->findOrFail($id);
return new CategoryResource($category);
}
/**
* @OA\Get(
* path="/blog/categories/{slug}/posts",
* tags={"Categories"},
* summary="Get posts by category slug",
* @OA\Parameter(name="slug", in="path", required=true, @OA\Schema(type="string")),
* @OA\Parameter(name="per_page", in="query", @OA\Schema(type="integer")),
* @OA\Response(response=200, description="OK"),
* @OA\Response(response=404, description="Category not found")
* )
*/
public function getCategoryWithPosts(Request $request, $slug)
{
$category = Category::where('slug', $slug)->first();
@@ -87,12 +120,31 @@ class CategoryController extends Controller
], 200);
}
/**
* @OA\Post(
* path="/blog/categories",
* tags={"Categories"},
* summary="Create a category",
* @OA\RequestBody(@OA\MediaType(mediaType="application/json")),
* @OA\Response(response=201, description="Created")
* )
*/
public function store(StoreCategoryRequest $request)
{
$category = Category::create($request->validated());
return new CategoryResource($category);
}
/**
* @OA\Put(
* path="/blog/categories/{id}",
* tags={"Categories"},
* summary="Update a category",
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
* @OA\RequestBody(@OA\MediaType(mediaType="application/json")),
* @OA\Response(response=200, description="OK")
* )
*/
public function update(UpdateCategoryRequest $request, $id)
{
$category = Category::findOrFail($id);
@@ -100,6 +152,15 @@ class CategoryController extends Controller
return new CategoryResource($category);
}
/**
* @OA\Delete(
* path="/blog/categories/{id}",
* tags={"Categories"},
* summary="Delete a category",
* @OA\Parameter(name="id", in="path", required=true, @OA\Schema(type="integer")),
* @OA\Response(response=200, description="OK")
* )
*/
public function destroy($id)
{
$category = Category::findOrFail($id);