caoym/phprs-restful

PHP RESTful API framework.

PhpBoot

, _(*1)

phprs-restful 2.x is renamed to PhpBoot, and incompatible with 1.x. You can get the old version from phprs-restful v1.x, _(*2)

查看中文说明, _(*3)

PhpBoot is an easy and powerful PHP framework for building RESTful/Microservices APIs., _(*4)

Specialities

PhpBoot provides mainstream features, such as IOC, HOOK, ORM, Validation, etc. But the most striking features are:, _(*5)

1. Designing object-oriented APIs

WITHOUT PhpBoot:, _(*6)

class BookController
{
    public function findBooks(Request $request)
    {
        $name = $request->get('name');
        $offset = $request->get('offset', 0);
        $limit = $request->get('limit', 10);
        ...
        return new Response(['total'=>$total, 'data'=>$books]);
    }

    public function createBook(Request $request)
    ...
}

WITH PhpBoot:, _(*7)

/**
 * @path /books/
 */
class Books
{
    /**
     * @route GET /
     * @return Book[]
     */
    public function findBooks($name, &$total=null, $offset=0, $limit=10)
    {
        $total = ...
        ...
        return $books;
    }

    /**
     * @route POST /
     * @param Book $book {@bind request.request} bind $book with http body
     * @return string id of created book
     */
    public function createBook(Book $book)
    {
        $id = ... 
        return $id;
    }
}

Read more: phpboot-example。    , _(*8)

2. Swagger

PhpBoot can automatically generate Swagger JSON，which can be rendered as document by Swagger UI like this：, _(*9)

Read more: Online Demo, _(*10)

3. RPC

Call the remote Books with RPC:, _(*11)

$books = $app->make(RpcProxy::class, [
        'interface'=>Books::class, 
        'prefix'=>'http://x.x.x.x/'
    ]);

$books->findBooks(...);

Concurrent call RPC：, _(*12)

$res = MultiRpc::run([
    function()use($service1){
        return $service1->doSomething();
    },
    function()use($service2){
        return $service2->doSomething();
    },
]);

Read more: RPC, _(*13)

4. IDE friendly

Features

• Route
• Parameters binding
• Validation
• Dependency Injection(IOC)
• DB
• ORM
• Docgen(Swagger)
• RPC
• Hook
• CLI

Installation

1. Install composer, _(*14)

   curl -s http://getcomposer.org/installer | php, _(*15)

2. Install PhpBoot, _(*16)

   composer require "caoym/phpboot", _(*17)

3. index.php, _(*18)

   ```PHP <?php require DIR.'/vendor/autoload.php';, <sub>(*19)</sub>

   $app = \PhpBoot\Application::createByDefault(DIR.'/config/config.php'); $app->loadRoutesFromPath(DIR.'/App/Controllers'); $app->dispatch(); ```, <sub>(*20)</sub>

Help & Documentation

• Documentation
• 中文文档
• Email: caoyangmin@gmail.com