README

مقدمه

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

مستندات api در (https://kitsu.docs.apiary.io/#introduction) در دسترس است

پروژه: (https://gitlab.com/s1njar/kitsu-php/)

نصب

برای نیاز به این بسته، کامپوزر را اجرا کنید

composer require s1njar/kitsu-php

استفاده

روند پیش‌فرض

//Create new SearchBuilder object.
$searchBuilder = new SearchBuilder();

//Add the endpoint to be requested.
//Calling after setting filters, filters will be resetted.
$searchBuilder = $searchBuilder->setEndpoint('anime');

//Add the fields you want to return.
$searchBuilder = $searchBuilder->addFields(['slug'], 'anime');

//Add filter to refine the search.
$searchBuilder = $searchBuilder->addFilter('slug', 'naruto');

//Add filter to refine the search, with greater than or lower than.
$searchBuilder = $searchBuilder->addFilter('slug', 'naruto', SearchBuilder::FILTER_RANGE_GREATER_THAN);

//Add a limit.
$searchBuilder = $searchBuilder->addLimit(10);

//Add an offset.
$searchBuilder = $searchBuilder->addOffset(0);

//Add an order. Default ascending.
$searchBuilder = $searchBuilder->addOrder('slug');

//Add an order, with order direction descending
$searchBuilder = $searchBuilder->addOrder('slug', SearchBuilder::ORDER_DIRECTION_DESC);

//Trigger the search. It returns an Response object. Ignores filter.
//Can take list of fields to return.
$searchBuilder = $searchBuilder->searchById(1, ['slug']);

//Trigger the search. It returns an Response object.
$searchBuilder = $searchBuilder->search();

//Decode the response from the server and return an array of objects.
$response = $searchBuilder->get();

درخواست با شناسه.

//Create new SearchBuilder object.
$searchBuilder = new SearchBuilder();

//Add endpoint and search by id.
$response = $searchBuilder
    ->setEndpoint('anime')
    ->searchById(1, ['slug'])
    ->get();

درخواست با جستجو

//Create new SearchBuilder object.
$searchBuilder = new SearchBuilder();

//Add endpoint and search needle.
$searchBuilder
    ->setEndpoint('anime')
    ->addFilter('slug', 'naruto', SearchBuilder::FILTER_RANGE_GREATER_THAN)
    ->addOrder('slug', 'desc', SearchBuilder::ORDER_DIRECTION_DESC)
    ->addLimit(20)
    ->addOffset(0)
    ->search()
    ->get()

فرمت پاسخ

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

اگر یک منبع تنها درخواست شود، نیز به عنوان یک مجموعه بازگردانده می‌شود.

پاسخ نمونه

[
    0 => {
        "id": "1",
        "type": "anime",
        "links": {
            "self": "https://kitsu.io/api/edge/anime/1"
        },
        "attributes": {
            "createdAt": "2013-02-20T16:00:13.609Z",
            "updatedAt": "2020-07-26T13:18:42.333Z",
            "slug": "cowboy-bebop"
    },
    1 => {
        "id": "11",
        "type": "anime",
        "links": {
            "self": "https://kitsu.io/api/edge/anime/11"
        },
        "attributes": {
            "createdAt": "2013-02-20T16:00:24.797Z",
            "updatedAt": "2020-07-26T14:53:19.709Z",
            "slug": "naruto"
    }
]

API کیتسو

• مستندات را بررسی کنید

اعتبارها

• سینجر

لیسانس

لیسانس MIT (MIT).