مرجع وب سرویس
دیدگاهها (Comments)
دیدگاهها (Comments) امکان تعامل کاربران با پستها را فراهم میکنند. هر دیدگاه میتواند شامل پاسخهای تودرتو باشد و توسط ادمین فضای کاری پین یا اسپم شود.
نوعهای مشترک (Common Types)
| نام | توضیح |
|---|---|
Comment | شیء اصلی دیدگاه |
فیلدهای Comment:
| فیلد | نوع | توضیح |
|---|---|---|
id | number | شناسه یکتای دیدگاه |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
updated_at | string | تاریخ و زمان آخرین ویرایش |
post_id | number | شناسه پست مربوطه |
workspace_id | number | شناسه فضای کاری مربوطه |
parent_id | number | null | شناسه دیدگاه والد (برای پاسخها) |
content | string | متن دیدگاه |
is_spam | boolean | وضعیت اسپم بودن دیدگاه |
is_pinned | boolean | null | وضعیت پین بودن دیدگاه |
likes_count | number | تعداد لایکها |
replies_count | number | تعداد پاسخها |
is_liked | boolean | آیا کاربر جاری لایک کرده است؟ |
replies | []Comment | آرایه پاسخهای این دیدگاه |
external_author | ExternalAuthor | اطلاعات نویسنده دیدگاه |
فیلدهای ExternalAuthor:
| فیلد | نوع | توضیح |
|---|---|---|
id | string | شناسه یکتای کاربر (UUID) |
created_at | string | تاریخ و زمان ایجاد (فرمت ISO 8601) |
email | string | ایمیل |
full_name | string | نام کامل |
avatar_url | string | null | آدرس آواتار |
مدیریت دیدگاهها (Comments)
دریافت لیست دیدگاههای یک پست
GET https://api.fidegah.ir/v1/posts/:postId/comments
curl -X GET https://api.fidegah.ir/v1/posts/{postId}/comments \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای Query (Query Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
search | string | جستجو براساس متن دیدگاه |
isSpam | boolean | فیلتر براساس وضعیت اسپم |
isPinned | boolean | فیلتر براساس وضعیت پین |
externalUserId | string | فیلتربراساس شناسه ایجادکننده — با کاما جدا کنید |
sortBy | string | فیلد مرتبسازی (پیشفرض created_at) |
sortOrder | 'asc' | 'desc' | جهت مرتبسازی (پیشفرض desc) |
پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | []Comment | آرایه شامل لیست دیدگاهها (هر دیدگاه شامل پاسخهای آن نیز میباشد) |
pagination | Pagination | اطلاعات صفحهبندی (مشاهده جزئیات) |
ایجاد دیدگاه جدید
POST https://api.fidegah.ir/v1/posts/:postId/comments
curl -X POST https://api.fidegah.ir/v1/posts/{postId}/comments \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content": "دیدگاه من",
"user": {
"id": "uuid-here",
"email": "user@example.com",
"full_name": "نام کاربر"
}
}'پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مورد نظر |
بدنه درخواست (Request Body):
| پارامتر | نوع | ضرورت | توضیح |
|---|---|---|---|
content | string | الزامی | متن دیدگاه (حداقل ۱ کاراکتر) |
user | User | الزامی | اطلاعات نویسنده دیدگاه |
parent_id | number | اختیاری | شناسه دیدگاه والد (در صورت پاسخ به دیدگاه دیگری) |
is_pinned | boolean | اختیاری | پین کردن دیدگاه (پیشفرض false) |
فیلدهای User:
| فیلد | نوع | ضرورت | توضیح |
|---|---|---|---|
id | string | الزامی | شناسه یکتای نویسنده (UUID) |
email | string | الزامی | ایمیل نویسنده |
full_name | string | الزامی | نام کامل نویسنده |
avatar_url | string | اختیاری | آدرس آواتار نویسنده |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Comment | شیء دیدگاه ایجاد شده |
ویرایش دیدگاه
PATCH https://api.fidegah.ir/v1/posts/:postId/comments/:commentId
curl -X PATCH https://api.fidegah.ir/v1/posts/{postId}/comments/{commentId} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"content": "متن ویرایش شده"
}'پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مربوطه |
commentId | number | شناسه دیدگاه مورد نظر |
بدنه درخواست (Request Body - همگی اختیاری):
| پارامتر | نوع | دسترسی | توضیح |
|---|---|---|---|
content | string | نویسنده و ادمین | متن جدید دیدگاه |
is_pinned | boolean | فقط ادمین | وضعیت پین بودن دیدگاه |
is_spam | boolean | فقط ادمین | وضعیت اسپم بودن دیدگاه |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
data | Comment | شیء دیدگاه پس از ویرایش |
حذف دیدگاه
DELETE https://api.fidegah.ir/v1/posts/:postId/comments/:commentId
curl -X DELETE https://api.fidegah.ir/v1/posts/{postId}/comments/{commentId} \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"پارامترهای مسیر (Path Parameters):
| پارامتر | نوع | توضیح |
|---|---|---|
postId | number | شناسه پست مربوطه |
commentId | number | شناسه دیدگاه مورد نظر |
خروجی درخواست:
| فیلد | نوع | توضیح |
|---|---|---|
success | boolean | وضعیت موفقیتآمیز بودن درخواست |
message | string | پیام نتیجه حذف |