Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caoym/phpboot
:coffee: 🚀 tiny & fast PHP framework for building Microservices/RESTful APIs, with useful features: IOC, Hook, ORM, RPC, Swagger, Annotation, Parameters binding, Validation, etc.
https://github.com/caoym/phpboot
annotation framework microservices orm restful rpc swagger
Last synced: 2 months ago
JSON representation
:coffee: 🚀 tiny & fast PHP framework for building Microservices/RESTful APIs, with useful features: IOC, Hook, ORM, RPC, Swagger, Annotation, Parameters binding, Validation, etc.
- Host: GitHub
- URL: https://github.com/caoym/phpboot
- Owner: caoym
- License: mit
- Created: 2015-10-08T07:37:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-06-02T05:15:14.000Z (over 3 years ago)
- Last Synced: 2024-07-09T08:42:04.583Z (6 months ago)
- Topics: annotation, framework, microservices, orm, restful, rpc, swagger
- Language: PHP
- Homepage: http://phpboot.org
- Size: 1.13 MB
- Stars: 657
- Watchers: 76
- Forks: 175
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- php-awesome - phprs - 一款轻量、类 jax-rs、实用的 PHP 框架 (类库 / API)
README
# PhpBoot
[](https://raw.githubusercontent.com/caoym/phpboot/master/LICENSE)
[](https://packagist.org/packages/caoym/phpboot)
[](http://phpboot.readthedocs.io/zh/latest/?badge=latest)
[](https://travis-ci.org/caoym/phpboot)
[](https://scrutinizer-ci.com/g/caoym/phpboot/?branch=master)
[](https://scrutinizer-ci.com/g/caoym/phpboot/?branch=master)
> phprs-restful 2.x is renamed to PhpBoot, and incompatible with 1.x. You can get the old version from [phprs-restful v1.x](https://github.com/caoym/phprs-restful/tree/v1.2.4)
[查看中文说明](https://github.com/caoym/phpboot/blob/master/README.zh.md)
**[PhpBoot](https://github.com/caoym/phpboot)** is an easy and powerful PHP framework for building RESTful/Microservices APIs.
## Specialities
PhpBoot provides mainstream features, such as IOC, HOOK, ORM, Validation, etc. But the most striking features are:
### 1. Designing object-oriented APIs
**WITHOUT** PhpBoot:
```PHP
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:
```PHP
/**
* @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](https://github.com/caoym/phpboot-example)。
### 2. Swagger
PhpBoot can automatically generate Swagger JSON，which can be rendered as document by Swagger UI like this：
Read more: [Online Demo](http://swagger.phpboot.org/?url=http://example.phpboot.org/docs/swagger.json)
### 3. RPC
Call the remote Books with RPC:
```PHP
$books = $app->make(RpcProxy::class, [
'interface'=>Books::class,
'prefix'=>'http://x.x.x.x/'
]);
$books->findBooks(...);
```
Concurrent call RPC：
```PHP
$res = MultiRpc::run([
function()use($service1){
return $service1->doSomething();
},
function()use($service2){
return $service2->doSomething();
},
]);
```
Read more: [RPC](http://phpboot.org/zh/latest/advanced/rpc.html)
### 4. IDE friendly
## Features
* [Route](http://phpboot.org/zh/latest/basic/route.html)
* [Parameters binding ](http://phpboot.org/zh/latest/basic/params-bind.html)
* [Validation](http://phpboot.org/zh/latest/basic/validation.html)
* [Dependency Injection(IOC)](http://phpboot.org/zh/latest/basic/di.html)
* [DB](http://phpboot.org/zh/latest/basic/db.html)
* [ORM](http://phpboot.org/zh/latest/advanced/orm.html)
* [Docgen(Swagger)](http://phpboot.org/zh/latest/advanced/docgen.html)
* [RPC](http://phpboot.org/zh/latest/advanced/rpc.html)
* [Hook](http://phpboot.org/zh/latest/advanced/hook.html)
* [CLI](http://phpboot.org/zh/latest/advanced/cli.html)
## Installation
1. Install composer
```
curl -s http://getcomposer.org/installer | php
```
2. Install PhpBoot
```
composer require "caoym/phpboot"
```
3. index.php
```PHP
loadRoutesFromPath(__DIR__.'/App/Controllers');
$app->dispatch();
```
## Help & Documentation
* **[Documentation](http://phpboot.org)**
* **[中文文档](http://phpboot.org)**
* Email: [email protected]