Yii2 REST API params

Запись от and_y87 размещена 09.04.2024 в 18:59

Показов 1210 Комментарии 0

Frontend

Для всех запросов в Yii2, контроллеры которых используют yii\rest\Controller (REST API)

Можно регулировать список возвращаемых полей в моделях, добавляя в URL запроса GET параметр `filelds`
значение параметра = через запятую, список "полей" которые необходимо вернуть

EXAMPLE: filelds=id,created_at

Для index(listing) запросов:

можно указать необходимую страницу:

page=1

можно указать кол-во элементов на странице:

per-page=20

можно указать для выдачи поле/поля для сортировки по определённому направлению(ACS/DESC):

sort=created_at (ACS сортирует по возрастанию)
sort=-created_at,id (DESC сортирует по убыванию, [знак минус перед сортируемой колонкой])

зная поля/колонки модели/таблицы можно фильтровать выдачу добавляя параметр `filter` :

Для фильтрации по полю/колонке ( к примеру по определённому id ) :

filter[id]=3024230

Для фильтрации по принципу входит в список/массив применяется запись вида(к примеру для фильтрации по id):

filter[id][in][]=3024230&filter[id][in][]=3024220&filter[id][in][]=3024227

Для фильтрации по условию больше/меньше

filter[updated_at][<]=2023-12-25
filter[created_at][>]=2023-12-25

Для поска вхождения

filter[title][like]=cheese

Backend.

Создание алиасов/синонимов для атрибутов модели

PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
public function actions()
{
    $actions = parent::actions();
    
    $actions['index']['dataFilter'] = [
        'class' => \yii\data\ActiveDataFilter::class,
        'attributeMap' => [
            'clockIn' => 'clock_in',
        ],
        'searchModel' => (new DynamicModel(['id', 'clockIn']))->addRule(['id', 'clockIn'], 'integer', ['min' => 1]),
    ];
    
    return $actions;
}

Источники: yiiframework.com

Размещено в php, Back-End Разработка, Разработка Сайтов

« Даже "лучше" совершают ошибки Главная страница Словари »

Надоела реклама? Зарегистрируйтесь и она исчезнет полностью.

Всего комментариев 0

Комментарии

and_y87

Регистрация 27.02.2012
Адрес Россия, Москва, САО
Сообщений 1,379
Записей в блоге 98

Новые блоги и статьи Все статьи Все блоги /
20. Мат мед. Абсентеизм как отдельный тип простоя anaschu 29.05.2026 Апдейт модели: исправленные баги, абсентеизм и новые механизмы Продолжаю развивать ранее описанную модель рабочего коллектива на AnyLogic. За последние несколько дней был проведён серьёзный. . .	19. здоровье, усталость и психотип работника влияют на производительность предприятия, и наоборот, производительность на здоровье, усталось и психотип anaschu 28.05.2026 Дискретно-событийная модель рабочего коллектива на AnyLogic: здоровье, выгорание, психотипы и микростимуляция Привет, коллеги. Хочу поделиться итогами нескольких недель работы над симуляционной. . .	"Прокси" для последовательного порта Eddy_Em 28.05.2026 Эту штуку написал я достаточно давно. Но сейчас вот понадобилось настроить датчик грозы, но при этом не отключать его от "метеодемона". Соответственно, надо запустить этот "прокси": метеодемон будет. . .	Рефакторинг программы уравнивания. Massaraksh7 26.05.2026 Пример по предыдущей записи в блоге. Но, надо заметить, что, во-первых, там оптимизация не только математики, но и работы с базой данных, и с графами, а во-вторых, это ещё не всё.
Использование TThread в Lazarus для математических вычислений. Massaraksh7 25.05.2026 Производя рефакторинг своих программ на предмет ускорения их работы, обратил внимание на такой аспект, как сокращение времени матвычислений. Дело в том, что приходится работать с большими матрицами. . .	Модель здравосохранения 18. Чем здоровее работник, тем быстрее выгорает anaschu 24.05.2026 Имитационная модель корпоративного здравоохранения: что показывает математика Сегодня в модели рабочего коллектива на AnyLogic появились три новые механики — выгорание через накопленную усталость,. . .	Модель здравосохранения 17. Планы на выгорание anaschu 23.05.2026 Вот конкретная схема реализации: В классе Работник добавить: накопленнаяУсталость — растёт каждый час работы, снижается в перерывы и болезни коэффициентПрезентеизма — снижает продуктивность. . .	Изменение цветов в палитре gif файла aka фавикона russiannick 23.05.2026 Изменение цветов в палитре gif файла, юзаемого как фавиконка в составе html-файла, помещенная в base64, средствами нативного Java Script, навеянное сном в майский день. Для работы необходим браузер,. . .

Наверх

Сообщение форума

Отменить изменения