zulfajuniadi/tinyrest

单文件JSON REST服务器

0.0.2 2014-10-08 00:30 UTC

This package is not auto-updated.

Last update: 2024-09-24 03:49:19 UTC


README

###这是什么?

一种通过两行代码快速启动php REST后端的方法。不建议在生产环境中使用。我主要用它来在开发过程中测试客户端JavaScript / 移动应用程序。

###安装

composer require zulfajuniadi/tinyrest:0.*

###使用方法

假设我的小应用程序有两个RESTful端点

  • /projects
  • /tasks

通过以下方式实例化TinyREST

new Tinyrest\Handle(['projects', 'todos']);

我现在为我的应用程序拥有一个功能齐全的后端,可以处理这些路由

项目路由

待办事项路由

###示例

查看示例文件夹中的index.php文件。

###事件监听器

TinyREST公开了on方法,允许您绑定到端点上的事件。比如说,我要记录所有在项目上创建的数据,我会这样做

    $TinyRest = new Tinyrest\Handle(['projects', 'todos'], '../data/');
    $projects = $TinyRest->router('projects');
    
    // Do something when a new project is created
    $listener_id = $projects->on('create', function($new_data){
        // Log $new_data creation
    });
    
    // To stop listening to the event
    $projects->off('create', $listener_id);

触发的事件

###数据持久性

TinyREST将每个端点数据存储在其自己的public目录下的.json文件中。要更改目录,请提供第二个参数以指向您的首选数据目录,如下例所示

new Tinyrest\Handle(['projects', 'todos'], '../data/');

###欢迎贡献

您的贡献非常受赞赏,尤其是在以下这些领域

  • 提供单元测试
  • 错误报告和修复
  • 文档

请将该仓库fork并创建一个pull request以合并。

###许可证

ISC

版权(c)2014,Zulfa Juniadi bin Zulkifli

在此授予使用、复制、修改和/或以任何目的分发本软件的许可,无论是否收费,前提是上述版权声明和本许可声明出现在所有副本中。

本软件按“原样”提供,作者放弃与此软件相关的所有保证,包括所有默示的适销性和适用性保证。在任何情况下,作者均不对任何特殊、直接、间接或后果性损害或任何损害赔偿责任(无论是否因合同、疏忽或其他侵权行为而引起,或与使用或性能有关)承担责任,无论是否因使用或性能而造成损失、数据或利润的损失。