Skip to main content
#P1719

RESOURCE /v2/tags

Tag Resource Management

این بخش شامل مدیریت کامل تگ‌ها (Tags) است که برای برچسب‌گذاری روی مقالات و سایر محتواها استفاده می‌شود.
این کنترلر از ساختار استاندارد Resource در لاراول پیروی می‌کند.

1. List Tags (Index)

URL: /v2/tags
Method: GET
Controller: TagController@index

لیست تگ‌ها را به صورت صفحه‌بندی شده (۱۵ آیتم در هر صفحه) برمی‌گرداند.

مثال پاسخ

{
  "status": true,
  "time": 1715015000,
  "data": [
    {
      "id": 1,
      "title": "Laravel",
      "slug": "laravel",
      "description": "PHP Framework"
    }
  ],
  "links": {
    "first": "http://.../v2/tags?page=1",
    "last": "http://.../v2/tags?page=5",
    "prev": null,
    "next": "http://.../v2/tags?page=2"
  }
}

2. Create Tag (Store)

URL: /v2/tags
Method: POST
Controller: TagController@store

یک تگ جدید ایجاد می‌کند. پارامتر branch به صورت خودکار از درخواست (احتمالاً از توکن کاربر یا میدل‌ور) دریافت و ثبت می‌شود.

بدنه درخواست (Body Parameters)

Field Type Description
title string (الزامی) عنوان تگ
slug string (الزامی) آدرس یکتا (معمولاً انگلیسی)
description text توضیحات تگ (اختیاری)

مثال پاسخ موفق

{
  "status": true,
  "time": 1715015100,
  "data": {
      "id": 12,
      "title": "New Tag",
      "slug": "new-tag",
      "description": "..."
  }
}

3. Show Tag

URL: /v2/tags/{id}
Method: GET
Controller: TagController@show

مشاهده جزئیات یک تگ خاص بر اساس ID.

4. Update Tag

URL: /v2/tags/{id}
Method: PUT/PATCH
Controller: TagController@update

ویرایش اطلاعات تگ. فیلدها مشابه متد Store هستند.

{
    "status": true,
    "time": 1715015200
}

5. Delete Tag

URL: /v2/tags/{id}
Method: DELETE
Controller: TagController@destroy

حذف تگ از سیستم.

Delete Request
↓
Find Tag by ID
↓
Delete Record
↓
Return {status: true}
Back to top