Rapiq

Appearance

On this page

What is it? ​

Rapiq (Rest Api Query) is a library to build an efficient interface between client- & server-side applications. It defines a scheme for the request, but not for the response.

Important NOTE

The guide is under construction ☂ at the moment. So please stay patient or contribute to it, till it covers all parts ⭐.

Parameters ​

  • fields
    • Description: Return only specific resource fields or extend the default selection.
    • URL-Parameter: fields
  • filters
    • Description: Filter the resources, according to specific criteria.
    • URL-Parameter: filter
  • relations
    • Description: Include related resources of the primary resource.
    • URL-Parameter: include
  • pagination
    • Description: Limit the number of resources returned from the entire collection.
    • URL-Parameter: page
  • sort
    • Description: Sort the resources according to one or more keys in asc/desc direction.
    • URL-Parameter: sort