yuido/restrpc-bundle

一组用于简化基于REST RPC的API的创建的工具

安装: 13

依赖项: 0

建议者: 0

安全性: 0

星标: 0

关注者: 3

分支: 0

开放问题: 0

类型:symfony-bundle

v1.3 2016-10-20 12:24 UTC

This package is not auto-updated.

Last update: 2024-09-18 19:33:56 UTC


README

此扩展包提供以下工具,以简化REST RPC API的创建:

  • 一个通用的控制器,具有CRUD操作,可以用来管理数据库中的任何表格。

  • 一个名为'rest_rpc'的服务,提供创建API的有用工具:通过json-schema验证请求,将请求中的JSON转换为PHP数组以便于操作,以及生成错误和成功响应的函数。

Resources\doc中的教程中,用示例解释了基于此扩展包创建API的策略。

安装

将扩展包添加到项目中

composer.phar require yuido/restrpc-bundle "^1.*"

app/AppKernel.php中注册扩展包

new Yuido\RestRpcBundle\YuidoRestRpcBundle(),

app/config/routing.yml中添加路由

rest_rpc:
    resource: "@YuidoRestRpcBundle/Controller/"
    type:     annotation

创建一个目录,用于放置定义请求操作的JSON格式(json-schemas)。我们可以创建在任何位置。一个好位置可能是app/config/schemas

app\config\config.yml文件中添加json-schemas的路径。

yuido_rest_rpc:
    debug: true  
    json_schemas_dir: %kernel.root_dir%/config/schemas

debug参数用于在错误响应中返回有关错误更多的信息。

文档

文档位于Resources/doc