endpoint.md

Endpoint

Every endpoint has built in request methods for the current EndpointName defintion.

The basic request methods of an Endpoint are:

name	type	description
get()	get
post()	post
put()	put
delete()	delete

Custom Endpoint Requests

In order to make custom endpoint requests for a given custom url with paramters, whether is post get or patch use:

<?php

namespace app\headless;

use luya\headless\Endpoint;

class ApiMymoduleUser extends Endpoint
{
    public function getEndpointName()
    {
        return 'admin/api-mymodule-user';
    }
    
    public static function login($email, $password)
    {
        return self::post()->setEndpoint('{endpointName}/login')->setArgs(['email' => $email, 'password' => $password]);
    }
}

The above example assumes you have an endpoint admin/api-mymodule-user/login where the post attributes email and password must be sent. Now you can easy use this in your Application like:

$resposne = ApiMymoduleUser::login('[email protected]', '12345678')->response($client);

if ($resposne->isSuccess()) {
    // now you can log in the user ...
} else {
    // display the errors from the validation
    var_dump($login->getContent());
}

The implementation on API side could look like this:

class UserController extends \luya\admin\ngrest\base\Api
{
    /**
     * @var string The path to the model which is the provider for the rules and fields.
     */
    public $modelClass = 'app\modules\mymodule\models\User';

    /**
     * Validate user
     */
    public function actionLogin()
    {
        $model = new UserLoginModel();
        $model->attributes = Yii::$app->request->post();
        
        if ($model->validate()) {
            return $model->user;
        }
        
        return $this->sendModelError($model);
    }
}

Expand

If you want to expand every get request you can override the existing get() method:

public static function get()
{
    return parent::get()->setExpand(['users', 'image']);
}