anroots / kohana-hapi
此包已被废弃,不再维护。未建议替代包。
Kohana 3.3的HTTP API模块
dev-master
2013-03-04 12:42 UTC
Requires
- php: >=5.4.0
- composer/installers: *
- nocarrier/hal: *
This package is not auto-updated.
Last update: 2022-02-01 12:23:27 UTC
README
HyperMedia Application Programming Interface - 用于构建HTTP API框架的Kohana模块。
处于开发中。请勿使用。 预计主要版本(向后不兼容)将快速增加。
它是什么
- 为您的Kohana项目添加API支持的框架
- 未完成
- 比通用型更严格
它不是什么
- RESTful - 好吧,有一点,但缺少[API成熟度模型的三级](http://www.crummy .com/writing/speaking/2008-QCon/act3.html)
- 可扩展和优化 - 适用于一个服务器、一个客户端的方法,其中客户端受供应商控制
- 已测试
安装
- 克隆并启用模块。使用git子模块、下载zip文件或添加Composer依赖项
- 为API控制器添加路由
<?php Route::set( 'api', 'api(/<controller>(/<id>(/<action>)))' ) ->defaults( array( 'directory' => 'API/V1/', 'controller' => 'About', 'action' => 'index' ) );
- 创建
APPPATH/classes/Controller/API/V1/Main.php
- 扩展Controller_HAPI
- 创建
APPPATH/classes/Controller/API/V1/About.php
- 扩展Controller_API_V1_Main
- 在
action_index
中编写
<?php $this->hapi(['about' => 'Hello, world']);
- 向`BASE_URL/api/v1/about`进行HTTP GET查询
待办事项
- 删除一些硬编码的值以支持不仅仅是JSON
- 编写代码文档、wiki、gh-pages
- 改进架构
- 改进API语义:在响应体中提供有意义的错误和状态消息
- 努力实现REST