有没有比较好的PHP Restful API 的开源项目或者实例代码？

Question

最近需要用PHP为移动APP提供后台API，看到国内PHP Restful API相关的资料比较少，想找一个代码学习学习，PHP上手才几天，现在急需要了解如何优雅的完成这个API。

Answer 1

如果你满足一下两个条件：

1. 对 PHP 还不是算很熟悉；

2. API 接口只需要简单提供几个；

3. 项目时间比较紧；

那么，我建议你选择简单一点的可以实现 RESTful 的小型框架。

为什么：

1. 不熟悉 PHP 的情况下，难以一下子掌握一个庞大的框架（比如：Phalcon、Laravel、YII 等等）；

2. 对于一般的开发人员来说，按时交功课还是很重要的；

3. 用 PHP 实现 RESTful 风格的 API，最重要的还是：路由的实现、HTTP 请求（request）的解析、HTTP （response）响应的良好封装和JSON 格式的良好支持;

如果是这样，我会推荐给你：

1. Slim

2. Bullet

更多轻量级的小型框架自己搜 REST。

不过，不能不说的是，既然希望看别人的代码进行学习，那么还是应该带着目的和疑问去会更好。所以建议可以先看看有些 RESTful API 的优秀设计，比如：GitHub、Mailgun、Enchant 等等。

除此之外，还可以参考一些网络上一些“最佳实践”，这就非常多了，这里就不罗列了。（可以咪一眼这个 GitHub）

在对 REST 有一些了解后，在带着想法去看，个人觉得会事半功倍吧。

最后，如果说你需要一个全栈式的 PHP 框架（掌握需要些时间）来实现 REST API 的话，那么也可以选择，比如 YII、Laravel 等等。不过我还是最喜欢 Phalcon 了，它实现 REST 也很简单 教程。

Answer 2

非 Flarum 莫属，完全的前后端分离。

• 后端归后端，用 Laravel 编写。

• 前端归前端，用 Mithril.js 编写。

前端和后端基于 jsonapi 通讯。

参考

• Flarum 技术架构 Architecture

Answer 3

推荐 PhpBoot，为快速开发 RESTful API 设计的PHP框架。它可以帮助开发者更聚焦在业务本身, 而将原来开发中不得不做, 但又重复枯燥的事情丢给框架, 比如编写接口文档、参数校验和远程调用代码等。

特色

PhpBoot 框架提供许多主流的特性, 如ORM、依赖注入等。 这些特性都经过精心设计和选择(有些是第三方开源代码,如 PHP-DI)，但和其他框架相比较, PhpBoot 最显著的特色是:

1. 以面向对象的方式编写接口

你肯定看到过这样的代码:

// **不用** PhpBoot 的代码
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)
    ...
}

很多主流框架都需要用类似代码编写接口。但这种代码的一个问题是, 方法的输入输出隐藏在实现里, 这不是通常我们提倡的编码方式。如果你对代码要求更高, 你可能还会实现一层 Service 接口, 而在 Controller 里只是简单的去调用 Service 接口。而使用 PhpBoot, 你可以用更自然的方式去定义和实现接口。上面的例子, 在 PhpBoot 框架中实现是这样的:

/**
 * @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;
    }
}

上面两份代码执行的效果是一样的。可以看到 PhpBoot 编写的代码更符合面向对象编程的原则, 以上代码完整版本请见phpboot-example。

2. 轻松支持 Swagger

Swagger是目前最流行的接口文档框架。虽然很多框架都可以通过扩展支持Swagger, 但一般不是需要编写很多额外的注释, 就是只能导出基本的路由信息, 而不能导出详细的输入输出参数。而 PhpBoot 可以在不增加额外编码负担的情况下, 轻松去完成上述任务，下图为findBooks对应的文档。更多内容请见文档和在线 Demo。

3. 简单易用的分布式支持

使用 PhpBoot 可以很简单的构建分布式应用。通过如下代码, 即可轻松远程访问上面示例中的 Books 接口:

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

同时还可以方便的发起并发请求, 如:

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

更多内容请查看文档

4. IDE 友好

IDE 的代码提示功能可以让开发者轻松不少, 但很多框架在这方面做的并不好, 你必须看文档或者代码, 才能知道某个功能的用法。PhpBoot 在一开始就非常注重框架的 IDE 友好性, 尽可能让框架保持准确的代码提示。比如下图是 DB 库在 PhpStorm 下的使用:

可以看到, IDE 的提示是符合 SQL 语法规则的, 并不是简单罗列所有 SQL 指令。

主要特性

• 基于Annotation的路由定义

• 接口参数双向绑定

• Validation

• 依赖注入

• DB

• ORM

• 自动文档和接口工具

• 分布式支持(RPC)

• Hook

• 工作流引擎(开发中...)

安装和配置

1. 安装 composer (已安装可忽略)

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

2. 安装 PhpBoot

   composer require "caoym/phpboot"

3. index.php 加载 PhpBoot

   <?php
   require __DIR__.'/vendor/autoload.php';
         
   $app = \PhpBoot\Application::createByDefault(__DIR__.'/config/config.php');
   $app->loadRoutesFromPath(__DIR__.'/App/Controllers');
   $app->dispatch();

帮助和文档

• GitHub

• 在线文档