krak / api
v0.6.1
2015-07-08 21:33 UTC
Requires
- doctrine/common: ^2.0
- krak/marshal: ^0.1
- nicmart/string-template: ^0.1
- nikic/iter: ^1.0
- symfony/http-foundation: ^2.0
Requires (Dev)
- pimple/pimple: ~3.0
- symfony/event-dispatcher: ~2.0
- symfony/http-kernel: ~2.0
README
一个为使用Symfony HttpKernel构建API而设计的框架
安装
通过composer安装
{
"require": {
"krak/api": "^0.6"
}
}
事件监听器
事件监听器包含一个名为ViewListener的选项,它将获取控制器的结果,并使用HTTP转换器将它们转换为合适的响应。
HttpConverter
将API响应转换为正确的格式为HTTP响应。
响应
响应是API数据的载体。响应包含状态类型,并在数据周围构建额外的头部或状态信息。
ResponseMarshaler
响应序列化器接收一个响应并创建要转换为HTTP响应的数组数据。
用法
响应序列化器附加到HttpConverters。
use Krak\Api\HttpConverter\JsonHttpConverter;
use Krak\Api\ResponseMarshaler\StatusResponseMarshaler;
$converter = new JsonHttpConverter();
$converter->setResponseMarshaler(new StatusResponseMarshaler());
StatusResponseMarshaler
状态响应序列化器将添加状态字段到响应数据中
待办事项
- 创建序列化器和修复Response对象模型