image

خوشحالم که تصمیم گرفتید APIهای سایت من رو ببینید. امیدوارم که توضیحات به قدری خوب باشن تا انگیزه نوشتن برنامه روی این APIها رو به شما بدن.

این APIها تماما باز بوده و برای همه قابل استفاده هستند. من تا جایی که بتونم سعی میکنم ورودی‌ها و اطلاعات رو اونطور که باید و با کیفیت بالا مدیریت کنم که بشه ازشون به خوبی استفاده کرد.

هدفم از اینکار، رشد وب فارسی در کنار بقیه برنامه‌نویس‌هاست و مشتاقم که باهم برای وب فارسی کارهایی انجام بدیم و اون رو تا حد امکان در کنار هم گسترش بدیم.

* توجه کنید که تمام CRUD اکشن‌هایی که روی کلمات اعمال میشن، قبل ار رخ دادن باید یکبار تایید بشن. برای اینکار، با هر درخواست، از شما آدرس ایمیلتون هم خواسته میشه، که من بتونم در صورت نیاز با شما تماس بگیرم. واضحه که اگر آدرس ایمیل درست نباشه، اکشن درخواست شده اتفاق نمیوفته.

https://admin.saidi27.com/api/dictionary/words GET

این ای‌پی‌آی، به شما یک لیست از تمام واژگان موجود در دیتا‌بیس رو برمی‌گردونه.

Request | چه چیزهایی باید از سمت شما ارسال بشه؟

    هیچی، در خواست رو خالی بفرستید.

Response Status | وضعیت پاسخ چه چیزهایی میتونه باشه؟

  • ۲۰۰ :درخواست موفقیت‌آمیز بود

پاسخی که از سرور دریافت میکنید:

[
    {
        "name": "Abstraction (اَبستِرَکشِن)",
        "slug": "abstraction-(اَبستِرَکشِن)",
        "definition": "روشی برای ساده سازی الگوریتم‌ها و دستورات"
    },
    {
        "name": "AJAX (اِی‌جَکس)",
        "slug": "ajax-(اِی‌جَکس)",
        "definition": "اکس‌ام‌ال و جاوااسکریپت همگام"
    }
 ]
https://admin.saidi27.com/api/dictionary/words/:slug GET

این ای‌پی‌آی، به شما یک آیتم از نوع واژه رو برمی‌گردونه.

Request | چه چیزهایی باید از سمت شما ارسال بشه؟

  • string :slug

Response Status | وضعیت پاسخ چه چیزهایی میتونه باشه؟

  • ۲۰۰ :درخواست موفقیت‌آمیز بود

  • ۴۰۴ :آیتم پیدا نشد

پاسخی که از سرور دریافت میکنید:

{
    "id": 3,
    "name": "Abstraction (اَبستِرَکشِن)",
    "definition": "روشی برای ساده سازی الگوریتم‌ها و دستورات",
    "description": "<p>ابسترکشن در برنامه&zwnj;نویسی، راهکاری و روشی برای کاهش پیچیدگی و افزایش بهره&zwnj;وری طراحی و پیاده&zwnj;سازی سیستم&zwnj;های کامپیوتریست. ابسترکشن&zwnj;ها پیچیدگی برنامه&zwnj;نویسی را با کمک APIهای ساده&zwnj;تر، کمتر میکنند.</p>",
    "alias_for": [],
    "alias": [{
        "id": 1,
        "name": "Programming (برنامه‌نویسی)",
        "definition": "برنامه‌نویسی فرایند تبدیل الگوریتم‌ها به نمادها یا کدهایی است که توسط یک زبان برنامه‌نویسی انجام شده تا برای کامپیوتر قابل فهم باشد.",
        "alias_for": [],
        "alias": [],
        "slug": "programming-(برنامه‌نویسی)"
    }, {
        "id": 2,
        "name": "Algorithm (الگوریتم)",
        "definition": "مجموعه‌ای از دستور‌العملها که طبق روال خاصی طی شده تا پاسخ یا پاسخ‌هایی را برگردانند.",
        "alias_for": [],
        "alias": [],
        "slug": "algorithm-(الگوریتم)"
    }, {
        "id": 4,
        "name": "API (اِی‌پی‌آی)",
        "definition": "ویژگی‌ها یا کدهایی هستند که ارتباط بین اجزای کد را راحتتر میکنند.",
        "alias_for": [],
        "alias": [],
        "slug": "api-(اِی‌پی‌آی)"
    }],
    "slug": "abstraction-(اَبستِرَکشِن)"
}
https://admin.saidi27.com/api/dictionary/words POST

این ای‌پی‌آی، برای شما یک واژه جدید رو میسازه.

Request | چه چیزهایی باید از سمت شما ارسال بشه؟

  • آدرس ایمیل شما :by

  • یک تعریف کلی از واژه :definition

  • توضیح کامل واژه، به همراه تگ‌های اچ‌تی‌ام‌ال :description

  • نام واژه :name

  • لیستی از آی‌دی واژگان مرتبط :alias

  • لیستی از آی‌دی واژگان والد :alias_for

Response Status | وضعیت پاسخ چه چیزهایی میتونه باشه؟

  • ۲۰۰ :درخواست موفقیت‌آمیز بود

  • ۴۰۰ :چیزی از سمت شما اشتباه ارسال شده

پاسخی که از سرور دریافت میکنید:

{
    "status": "word created",
    "msg": "word created successfully, please wait for the approve"
}
https://admin.saidi27.com/api/dictionary/words/:slug PUT

این ای‌پی‌آی، برای شما یک واژه رو بروز رسانی می‌کنه.

Request | چه چیزهایی باید از سمت شما ارسال بشه؟

  • آدرس ایمیل شما :by

  • یک تعریف کلی از واژه :definition

  • توضیح کامل واژه، به همراه تگ‌های اچ‌تی‌ام‌ال :description

  • نام واژه :name

  • لیستی از آی‌دی واژگان مرتبط :alias

  • لیستی از آی‌دی واژگان والد :alias_for

Response Status | وضعیت پاسخ چه چیزهایی میتونه باشه؟

  • ۲۰۰ :درخواست موفقیت‌آمیز بود

  • ۴۰۰ :چیزی از سمت شما اشتباه ارسال شده

  • ۴۰۴ :واژه مربوطه پیدا نشد

پاسخی که از سرور دریافت میکنید:

{
    "status": "word updated",
    "msg": "word updated successfully, please wait for the approve"
}
https://admin.saidi27.com/api/dictionary/words/:slug DELETE

این ای‌پی‌آی، برای شما یک واژه رو حذف می‌کنه.

Request | چه چیزهایی باید از سمت شما ارسال بشه؟

  • آدرس ایمیل شما :by

Response Status | وضعیت پاسخ چه چیزهایی میتونه باشه؟

  • ۲۰۰ :درخواست موفقیت‌آمیز بود

  • ۴۰۰ :چیزی از سمت شما اشتباه ارسال شده

  • ۴۰۴ :واژه مربوطه پیدا نشد

پاسخی که از سرور دریافت میکنید:

{
    "status": "word deleted",
    "msg": "word deleted successfully, please wait for the approve"
}
برگردیم به بالای صفحه