bullhorn/fast-rest

FastREST generates REST-ready models and controllers dynamically from a MySQL database schema, including foreign keys, table and column comments, and indexes.

v2.0.0 2020-11-06 18:38 UTC

Requires

• php: >=7.3
• ext-phalcon: >=3.4.5
• bullhorn/fast-rest-services: 2.0.0
• nicklewis/phalcon-db-mock: dev-master
• riverline/multipart-parser: ^2.0
• zircote/swagger-php: *

Requires (Dev)

• codeclimate/php-test-reporter: dev-master
• phalcon/incubator: >=2.0
• phpunit/phpunit: ^7

GPL-3.0-or-later

• Bullhorn

• framework
• rest
• api
• phalcon

README

Contribute

There are many ways to contribute to Bullhorn FastREST.

• Submit bugs and help us verify fixes as they are checked in.
• Review source code changes.
• Contribute bug fixes.

(Internal) Before Committing

• Make sure to write unit tests for any new code.
• Run all unit tests, fix any errors.
• Push
• Submit Pull Request

Documentation

Requirements

Prerequisite packages are:

• Phalcon >2.0
• Database must be MySQL
• All table column names must adhere to /^[a-zA-Z0-9\_]+$/

Examples

• See https://github.com/bullhorn/fast-rest/tree/master/examples/

Installation

Installing via Composer

Install composer in a common location or in your project:

curl -s http://getcomposer.org/installer | php

Create the composer.json file as follows:

{
    "require": {
        "bullhorn/fast-rest": "dev-master"
    }
}

Run the composer installer:

php composer.phar install

Installing via GitHub

Just clone the repository in a common location or inside your project:

git clone https://github.com/bullhorn/fast-rest.git

Autoloading from the Incubator

Add or register the following namespace strategy to your Phalcon\Loader in order to load classes from the incubator repository:

$loader = new Phalcon\Loader();

$loader->registerNamespaces(array(
     'Bullhorn\\FastRest' => '/path/to/bullhorn/fast-rest/Library/'
));

$loader->register();