api 二次 开发 禅道_禅道 Rest API 开发

本文介绍了如何在老旧的PHP系统中,利用PHP 5.3的命名空间特性,结合Slim微服务框架进行禅道API的二次开发。通过创建一个兼容禅道原有运行环境的类,实现新旧代码的融合,从而提供REST风格的API接口,兼容Redmine的REST规范。
摘要由CSDN通过智能技术生成

在老的 PHP 系统中使用 PHP 5.3以后的库

所谓老的系统,是指没有使用PHP 5.3以上命名空间(namespace)特性编码的系统。

但是,只要你的系统运行在 PHP 5.3及以上的环境,在你的老系统中,是可以使用这些基于新特性如命名空间编码的库或代码的。

以前只是有洁癖不用而已。

比如,我是个工具控,想让所用的禅道系统也像那些国际化开源 Issue 项目一样有一套标准开放的 API - 禅道本身是有套 html、json 自适配模式可以当接口用的,可以用于其他客户端或系统集成。这几天在尝试编写的用于兼容 Redmine REST 风格接口的禅道 PMS API,就有意识的用了这种混合的写法。

由于要兼容 Redmine 的 REST 风格,首先选用了 Slim 这个微服务框架,毫无疑问,它是要求运行环境>5.3的,但我总得复用禅道已有的代码,这样效率才高。

原理很简单,就是一根反斜杠,或者两根。

先用 composer 初始化了 slim 库。

重点部位的代码:

入口文件 index.php

require __DIR__ . '/vendor/autoload.php';

require __DIR__ . '/inc/zentao/nb/Autoloader.php';

\zentao\nb\Autoloader::register();

$app = \zentao\core\Application::app(dirname(ZTNB_ROOT)); //禅道的router

$slim = new \Slim\Slim();

$routes = require __DIR__ . '/data/config/routes.php';

foreach ($routes as $method => $_routes) {

if ($_routes) {

foreach ($_routes as $rule => $map) {

$slim->$method($rule, '\\zentao\\nb\\resource\\' . $map);

}

}

}

$slim->run();

\zentao\core\Application 是独立封装的兼容禅道原来运行环境的类,由禅道中的 framework/router.class.php 改造而来,主要用于加载禅道中的相关资源如配置文件、模型等。精华应该在这里面,主要是加了一些“\”来让微服务中能跑起来禅道运来的运行环境,并作为一个命名空间的桥梁可以在新的代码中调用。

再看看资源类的父类 \zentao\nb\Resource,片段

namespace zentao\nb;

/**

* 资源类 父类

*/

class Resource {

public function __construct() {

}

/**

* Load the model file of one module.

*

* @param string $methodName The method name, if empty, use current module's name.

* @access public

* @return object|bool If no model file, return false. Else return the model object.

*/

protected function loadModel($moduleName) {

$modelFile = \helper::setModelFile($moduleName);

/* If no model file, try load config. */

if (!\helper::import($modelFile)) {

$this->app->loadConfig($moduleName, false);

$this->app->loadLang($moduleName);

$this->dao = new dao();

return false;

}

$modelClass = class_exists('ext' . $moduleName . 'model') ? 'ext' . $moduleName . 'model' : $moduleName . 'model';

$modelClass = '\\' . $modelClass;

if (!class_exists($modelClass))

$this->app->triggerError(" The model $modelClass not found", __FILE__, __LINE__, $exit = true);

$this->$moduleName = new $modelClass();

$this->dao = $this->$moduleName->dao;

return $this->$moduleName;

}

这样可以在资源类中调用禅道的 model 类。

还有另外一种用法,加载语言包:

namespace zentao\nb\resource;

use zentao\nb\enum\BugType;

/**

* 项目自行定义的问题分类

*/

class IssueCategory extends \zentao\nb\resource {

public function fetchAll($format = 'json') {

global $app;

$types = $app->loadLang('bug')->bug->typeList;

$issue_categories = array();

foreach ($types as $key => $name) {

$issue_categories[] = array('id' => BugType::getIdByInterId($key), 'name' => $name);

}

echo json_encode(array('issue_categories' => $issue_categories));

}

/**

* 根据项目来取其中定义的分类

* @param int $projectId

* @param string $format

*/

public function fetchAllByProjectId($projectId, $format = 'json') {

$model = $this->loadModel('project');

$project = $model->getById($projectId);//TODO 支持按项目代号查找

if (!$project) {

$this->responseNotExixted();

}

global $app;

$types = $app->loadLang('bug')->bug->typeList;

$issue_categories = array();

foreach ($types as $key => $name) {

$issue_categories[] = array('id' => BugType::getIdByInterId($key), 'project' => array('id' => $projectId, 'name' => $project->name), 'name' => $name);

}

echo json_encode(array(

'issue_categories' => $issue_categories,

'total_count' => 2

));

}

}

基本项目结构如下:

项目只是初步成型,尚未完成。

这是在 NB 中的任务列表。

这是在 NB 中的任务详情。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值