torchline/frest

Introduction

This framework automatically fits a facade layer around your SQL tables and provides very configurable and powerful API endpoints. Just specify the desired behavior in a json file for each resource and you're ready to go., _(*1)

Define what is possible to be read back, what is read back by default, how it will look, etc., _(*2)

Features

• URL routing for resources
• CRUD operations
• unlimited related resource nesting in a single request
• functions on resources for custom behavior
• type checking
• pagination
• conditional searching (>, <, LIKE, etc.)

Installation

Require this package with composer:, _(*3)

composer require torchline/frest, _(*4)

Querying

Function names: gt, gte, lt, lte, in, like, _(*5)

        ?username=like(FullMetal~) - starts with
        ?money=gt(50) - greater than
        ?hair=in(blonde,black,red) - is one of

Partial objects:, _(*6)

        ?fields=id,username,email - read only these fields back
        ?fields=* - read all fields back
        (if no fields specified, it goes to default)

        ?fields=name,owner(id, firstName, lastName) - do partial reads on child objects

Miscellaneous:, _(*7)

    suppress_http_error_codes=true - make request always return 200 with actual http code embeded in response