Design/EasySoft-ZenTaoPMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 30 Wiki Activity

finish api doc. first commit

Browse Source
This commit is contained in:
thanatos
2021-09-16 16:10:49 +08:00
parent cefac14189
commit 0d116021db
36 changed files with 10599 additions and 939 deletions
Download Patch File Download Diff File Expand all files Collapse all files
module/api/model.php
+185 -14
View File
@@ -1,4 +1,5 @@
<?php
/**
* The model file of api module of ZenTaoCMS.
*
@@ -11,11 +12,155 @@
*/
class apiModel extends model
{
const STATUS_DOING = 'doing';
const STATUS_DONE = 'done';
const STATUS_HIDDEN = 'hidden';
const SCOPE_QUERY = 'query';
const SCOPE_FORM_DATA = 'formData';
const SCOPE_PATH = 'path';
const SCOPE_BODY = 'body';
const SCOPE_HEADER = 'header';
const SCOPE_COOKIE = 'cookie';
const PARAMS_TYPE_CUSTOM = 'custom';
/**
* Create an api doc.
* @param stdClass $params
* @return int
* @author thanatos thanatos915@163.com
*/
public function create($params)
{
$this->dao->insert(TABLE_API)->data($params)
->autoCheck()
->batchCheck($this->config->api->create->requiredFields, 'notempty')
->exec();
if(dao::isError()) return false;
return $this->dao->lastInsertID();
}
/**
* Update an api doc.
* @param $id
* @param $data
* @author thanatos thanatos915@163.com
*/
public function update($id, $data)
{
$oldApi = $this->dao->findByID($id)->from(TABLE_API)->fetch();
$data->id = $oldApi->id;
$data->version = $oldApi->version + 1;
$apiSpec = $this->getApiSpecByData($data);
$this->dao->replace(TABLE_API_SPEC)->data($apiSpec)->exec();
unset($data->id);
$this->dao
->update(TABLE_API)
->data($data)
->autoCheck()
->batchCheck($this->config->api->edit->requiredFields, 'notempty')
->where('id')->eq($id)
->exec();
return;
}
/**
* Get api doc by id.
*
* @param int $id
* @access public
* @return object
*/
public function getLibById($id, $version = 0)
{
if($version)
{
$fields = 'spec.*,api.id,api.product,api.lib,api.version,doc.name as libName,module.name as moduleName';
}
else
{
$fields = 'api.*,doc.name as libName,module.name as moduleName';
}
$model = $this->dao
->select($fields)
->from(TABLE_API)->alias('api')
->beginIF($version)->leftJoin(TABLE_API_SPEC)->alias('spec')->on('api.id = spec.doc')->fi()
->leftJoin(TABLE_DOCLIB)->alias('doc')->on('api.lib = doc.id')
->leftJoin(TABLE_MODULE)->alias('module')->on('api.module = module.id')
->where('api.id')->eq($id)
->beginIF($version)->andWhere('spec.version')->eq($version)->fi()
->fetch();
if($model)
{
$model->params = json_decode(htmlspecialchars_decode($model->params), true);
$model->response = json_decode(htmlspecialchars_decode($model->response), true);
}
return $model;
}
/**
* Get api doc list by module id
* @param int $libID
* @param int $moduleID
* @return array $list
* @author thanatos thanatos915@163.com
*/
public function getListByModuleId($libID = 0, $moduleID = 0)
{
if($moduleID > 0)
{
$sub = $this->dao->select('id')->from(TABLE_MODULE)->where('FIND_IN_SET(' . $moduleID . ', path)')->processSQL();
$where = 'module in (' . $sub . ')';
}
else
{
$where = 'lib = ' . $libID;
}
$list = $this->dao->select('*')
->from(TABLE_API)
->where($where)
->andWhere('deleted')->eq(0)
->fetchAll();
array_map(function ($item) {
$item->params = json_decode(htmlspecialchars_decode($item->params), true);
return $item;
}, $list);
return $list;
}
/**
* Get status text by status.
* @param $status
* @return string
* @author thanatos thanatos915@163.com
*/
public static function getApiStatusText($status)
{
global $lang;
switch($status)
{
case static::STATUS_DOING:
return $lang->api->doing;
case static::STATUS_DONE:
return $lang->api->done;
}
}
/**
* Get the details of the method by file path.
*
* @param string $filePath
* @param string $ext
* @param string $filePath
* @param string $ext
* @access public
* @return object
*/
@@ -26,8 +171,8 @@ class apiModel extends model
if(!class_exists($className)) helper::import($fileName);
$methodName = basename($filePath);
$method = new ReflectionMethod($className . $ext, $methodName);
$data = new stdClass();
$method = new ReflectionMethod($className . $ext, $methodName);
$data = new stdClass();
$data->startLine = $method->getStartLine();
$data->endLine = $method->getEndLine();
$data->comment = $method->getDocComment();
@@ -51,9 +196,9 @@ class apiModel extends model
/**
* Request the api.
*
* @param string $moduleName
* @param string $methodName
* @param string $action
* @param string $moduleName
* @param string $methodName
* @param string $action
* @access public
* @return array
*/
@@ -68,7 +213,7 @@ class apiModel extends model
foreach($_POST as $key => $value) $param .= ',' . $key . '=' . $value;
$param = ltrim($param, ',');
}
$url = rtrim($host, '/') . inlink('getModel', "moduleName=$moduleName&methodName=$methodName&params=$param", 'json');
$url = rtrim($host, '/') . inlink('getModel', "moduleName=$moduleName&methodName=$methodName&params=$param", 'json');
$url .= $this->config->requestType == "PATH_INFO" ? '?' : '&';
$url .= $this->config->sessionVar . '=' . session_id();
}
@@ -79,7 +224,7 @@ class apiModel extends model
foreach($_POST as $key => $value) $param .= '&' . $key . '=' . $value;
$param = ltrim($param, '&');
}
$url = rtrim($host, '/') . helper::createLink($moduleName, $methodName, $param, 'json');
$url = rtrim($host, '/') . helper::createLink($moduleName, $methodName, $param, 'json');
$url .= $this->config->requestType == "PATH_INFO" ? '?' : '&';
$url .= $this->config->sessionVar . '=' . session_id();
}
@@ -95,8 +240,8 @@ class apiModel extends model
/**
* Query sql.
*
* @param string $sql
* @param string $keyField
* @param string $sql
* @param string $keyField
* @access public
* @return array
*/
@@ -107,7 +252,7 @@ class apiModel extends model
$sql = trim($sql);
if(strpos($sql, ';') !== false) $sql = substr($sql, 0, strpos($sql, ';'));
$result = array();
$result = array();
$result['status'] = 'fail';
$result['message'] = '';
@@ -136,8 +281,7 @@ class apiModel extends model
$result['status'] = 'success';
$result['data'] = $rows;
}
catch(PDOException $e)
} catch(PDOException $e)
{
$result['status'] = 'fail';
$result['message'] = $e->getMessage();
@@ -146,4 +290,31 @@ class apiModel extends model
return $result;
}
}
/**
* @author thanatos thanatos915@163.com
*/
private function getApiSpecByData($data)
{
$now = helper::now();
return [
'doc' => $data->id,
'module' => $data->module,
'title' => $data->title,
'path' => $data->path,
'protocol' => $data->protocol,
'method' => $data->method,
'requestType' => $data->requestType,
'responseType' => $data->responseType,
'status' => $data->status,
'owner' => $data->owner,
'desc' => $data->desc,
'version' => $data->version,
'params' => $data->params,
'response' => $data->response,
'addedBy' => $this->app->user->account,
'addedDate' => $now,
];
}
}