A pretty library to help developers build RESTful APIs lightly, quickly and properly even without writing code 2020-11-06 03:03 UTC


A pretty library to help developers build RESTful APIs lightly, quickly and properly even without writing code.

It's always easy to customize to suit any need such as defining data relationships, authorization, caching, communicating or integrating into other systems.


  • Serves RESTful APIs for any MySql database
    • Pagination
    • Sorting
    • Selection
    • Grouping, Having
    • Filtering
    • Relationships
    • Metadata
  • Supports Event Bus

Using Apify


Apify is packed as a composer package. So it's installed quickly in 2 steps

  1. Require the composer package

    composer require megaads/apify

  2. Register the provider:


System requirements

  • PHP: >= 5.6
  • Laravel/ Lumen Framework: 5.4.*
  • MySQL
  • Message queue server: optional

API Overview

HTTP Method API URL Description For example
GET /api/entity List all records of table that match the query curl>20
GET /api/entity/:id Retrieve a record by primary key :id curl
POST /api/entity Insert a new record, bulk inserting is also avaiable curl -X POST -d '[{"username":"user1", "age":"20"},{"username":"user2", "age":"25"}]' -H "Content-Type: application/json"
PUT /api/entity/:id Replaces existed record with new one curl -X PUT -d '{"id":"123", "username":"user1", "age":"20"}' -H "Content-Type: application/json"
PATCH /api/entity/:id Update record element by primary key curl -X PATCH -d '{"age":"21"}' -H "Content-Type: application/json"
DELETE /api/entity/:id Delete a record by primary key curl -X DELETE
DELETE /api/entity Delete bulk records that match the query curl -X DELETE>100
POST /api/upload Upload a file curl -X POST -H "Content-Type: multipart/form-data" -F "data=@song.mp3"


Parameter Required Default Description
page_id No 0 Page index, start at 0
page_size No 50 Number of rows to retrieve per page


Order by multiple columns using sorts parameter

Sort ascending


Sort descending


Sort by multiple columns



Select columns from the records using fields parameter. SQL aggregate functions such as COUNT, MAX, MIN, SUM, AVG, SQL aliases are also available

/api/post?fields=id,content,user_id,sum(view_count) as view_sum

Group By

Group the result-set by one or more columns using groups parameter and combine with aggregate functions using Selection



Operator Condition For example
= Equal to /api/post?filters=user_id=1
!= Not equal /api/post?filters=user_id!=1
> Greater /api/post?filters=user_id>1
>= Greater or equal /api/post?filters=user_id>=1
< Less /api/post?filters=user_id<1
<= Less or equal /api/post?filters=user_id<=1
={} In /api/post?filters=user_id={1;2;3}
!={} Not in /api/post?filters=user_id!={1;2;3}
=[] Between /api/post?filters=user_id=[1;20]
!=[] Not between /api/post?filters=user_id!=[1;20]
~ Like /api/post?filters=title~hello
!~ Not like /api/post?filters=title!~hello

Apify supports filtering records based on more than one AND, NOT condition by using comma. For example:


Complex conditions that combine AND, OR and NOT will be available soon.

Entity conventions

Apify works by a simple mechanism, looking for a model class that correspond to the API entity, otherwise the API entity will be matched to a suitable DB table. That means no model class is required to create, do it only in the case of defining relationships, customizing.

So API entity name should follow one of the conventions:

  • The API entity name is the same as a model class name

  • Or the API entity name in snake_case that correspond to a model class with the name in CamelCase

  • Or the API entity name is the same as a DB table name


Apify is packed into a Laravel/ Lumen package so relationships also are defined as methods on Eloquent model classes.

See Laravel docs for details:

Let's consider the following relationship definations:

  • A Nation has many City (one-to-many relationship)
namespace App\Models;
class Nation extends \Apify\Models\BaseModel {
    protected $table = 'location_nation';
    public function cities() {
        return $this->hasMany('App\Models\City', 'nation_id', id);
  • A City belongs to a Nation (many-to-one relationship)
  • A City has many District (one-to-many relationship)
namespace App\Models;
class City extends \Apify\Models\BaseModel {
    protected $table = 'location_city';
    public function nation() {
        return $this->belongsTo('App\Models\Nation', 'nation_id');
    public function districts() {
        return $this->hasMany('App\Models\District', 'city_id', id);
  • A District belongs to a City (many-to-one relationship)
namespace App\Models;
class District extends \Apify\Models\BaseModel {
    protected $table = 'location_district';
    public function city() {
        return $this->belongsTo('App\Models\City', 'city_id');

Selection on relationships

Apify provides the ability to embed relational data into the results using embeds parameter

For example


Even nested relationships


Filtering on relationships



metric=get (by default): Retrieve all records that match the query




Response format

    "meta": {
        "has_next": true,
        "total_count": 100,
        "page_count": 2,
        "page_size": 50,
        "page_id": 0
    "result": [],
    "status": "successful"

metric=first: Retrieve the first record that matchs the query


Response format

    "result": {},
    "status": "successful"

metric=count: Retrieve the number of records that match the query


Response format

    "result": 50,
    "status": "successful"

metric=increment/ decrement: Provides convenient methods for incrementing or decrementing the value of a selected column


Response format

    "result": 1,
    "status": "successful"

Event Bus

Is being updated ...

.env configurations

Key Default value Description
APIFY_MODEL_NAMESPACE App\Models Models namespace
APIFY_UPLOAD_PATH /home/upload Upload path
APIFY_MQ_ENABLE false Enable / Disable Message queue (Event Bus)
APIFY_MQ_HOST Message queue server host
APIFY_MQ_PORT Message queue server port
APIFY_MQ_USERNAME Message queue authentication - username
APIFY_MQ_PASSWORD Message queue authentication - password
APIFY_MQ_EXCHANGE apify Message queue exchange name

Authenticate Apify & authorize Apify?

Read docs here :


The Apify is open-sourced software licensed under the MIT license

Contact us/ Instant feedback


Skype: phult.bk

If you find a bug, please report it here on Github.