Simple Rest API written using Phalcon PHP Framework 3.4 and its Micro app.

• Import SQL dump (erply.sql)
• Install Phalcon extension (this API is tested with 3.4) based on your OS and PHP version. Installation guides can be found here: https://phalcon.link/download
• Modify app/config/config.php with your DB credentials and baseUri

Since this is a test task, some things were simplified at the cost of scalability. Several known issues:

• Product price is kept in the same table as the product name. Ideally, there should be a separate table, e.g. product_state
• For simplicity I kept basic app structure which Phalcon recommends. For scalability purposes this could be rebuilt into modular one (like Symfony or Laravel).

Returns a list of products.

None

An array with the following keys and values:

• id — unique ID.
• name — unique product name.
• price — unique product price.

• 500 Internal Server Error — Internal server error.

Request

api/product

Return

{
    [
        {
            "id": "1",
            "name": "Batman Arkham City",
            "price": "39.99"
        },
        {
            "id": "2",
            "name": "Dead By Daylight",
            "price": "29.99"
        },
        {
            "id": "16",
            "name": "Cuphead",
            "price": "19.99"
        }
    ]
}

Searches for products by name.

• query — A keyword to search for (required, >= 3 characters).

An array with the following keys and values:

• id — unique ID.
• name — unique product name.
• price — unique product price.

• 400 Bad Request — Missing or short query string.
• 500 Internal Server Error — Internal server error.

Request

/api/product/search/batman

Return

{
    [
        {
            "id": "1",
            "name": "Batman Arkham City",
            "price": "39.99"
        }
    ]
}

Adds a new product.

Essential information:

• name — Product title.
• price — Product price.

An array with the following keys and values:

• status - request result status.
• data: name — unique product name. price — unique product price. id — unique ID.

• 400 Input parameters validation error — Invalid input parameters.
• 422 Unable to create product — Product name already exists.
• 500 Internal Server Error — Internal server error.

Request

POST api/product?name=Bioshock&price=8.99

Return

{
    "status": "OK",
    "data": {
        "name": "Bioshock",
        "price": "8.99",
        "id": "17"
    }
}

Updates an existing product.

The application must provide the ID of the product to update in the URL of the request. The following parameters are required in the POST body:

• name — Product title.
• price — Product price.

An array with the following keys and values:

• status - request result status.
• data: name — unique product name. price — unique product price. id — unique ID.

• 400 Input parameters validation error — Invalid input parameters.
• 404 Product not found — Product with given ID not found.
• 422 Unable to update product — Product name already exists.
• 500 Internal Server Error — Internal server error.

Request

PUT api/product/17?name=Bioshock%20Remastered&price=9.99

Return

{
    "status": "OK",
    "data": {
        "name": "Bioshock Remastered",
        "price": "9.99",
        "id": "17"
    }
}

Adds a new product.

Essential information:

• name — Product title.
• price — Product price.

An array with the following keys and values:

• status - request result status.
• data: name — unique product name. price — unique product price. id — unique ID.

• 400 Input parameters validation error — Invalid input parameters.
• 422 Unable to create product — Product name already exists.
• 500 Internal Server Error — Internal server error.

Request

POST api/product?name=Bioshock&price=8.99

Return

{
    "status": "OK",
    "data": {
        "name": "Bioshock",
        "price": "8.99",
        "id": "17"
    }
}

Deletes an existing product.

The application must provide the ID of the product to delete in the URL of the request.

A JSON object containing status.

• 404 Product not found — Product with given ID not found.
• 500 Internal Server Error — Internal server error.

Request

DELETE api/product/17

Return

{
    "status": "OK"
}