Validation for Modx Rest API

otemua · November 28, 2019, 10:44am

Hi,

What is recommended method for handling validation when using the Modx Rest API as shown here

Is it case just writing own custom validation, import some 3rd part library or does Modx have something built in to handle this? Possible to somehow hook into FormIt validation?

Thanks

bruno17 · November 28, 2019, 11:02am

you can set the different requiredFields

github.com

modxcms/revolution/blob/956c022d5ab4b74e483f9f2a37a816f44ea0f891/core/model/modx/rest/modrestcontroller.class.php#L67


/** @var int $defaultLimit The default number of records to return in the getList method */
public $defaultLimit = 20;
/** @var int $defaultOffset The default offset in the getList method */
public $defaultOffset = 0;
/** @var xPDOObject $object */
public $object;
/** @var array $searchFields Optional. An array of fields to use when the search parameter is passed */
public $searchFields = array();


/** @var array $postRequiredFields An array of required field keys that must be passed for POST requests */
public $postRequiredFields = array();
/** @var array $postRequiredRelatedObjects An array of classKey/field pairings for checking related objects on POST */
public $postRequiredRelatedObjects = array();
/** @var string $postMethod The method on the object to call for POST requests */
public $postMethod = 'save';
/** @var array $putRequiredFields An array of required field keys that must be passed for PUT requests */
public $putRequiredFields = array();
/** @var array $postRequiredRelatedObjects An array of classKey/field pairings for checking related objects on PUT */
public $putRequiredRelatedObjects = array();
/** @var string $putMethod The method on the object to call for PUT requests */
public $putMethod = 'save';

and you can do additional validation in beforePost or beforePut

otemua · November 29, 2019, 10:13am

Oh excellent will give that a try