API文档 By Api-Doc-PHP

API文档 By Api-Doc-PHP {$this->customCss}

{$this->_getDocList($data)}

版权的撒打算

{$this->customJs} EXT; if (isset($_GET['download']) && $_GET['download'] === 'api_doc_php') { Tools::downloadFile($html); return true; } return $html; } /** * 解析return 并生成HTML * @param array $data * @return string */ private function _getReturnData($data = []) { $html = ''; if (!is_array($data) || count($data) < 1) { return $html; } $html .= '

返回参数

'; $html .= ''; foreach ($data as $v) { $html .= ''; } $html .= '

参数	类型	描述
' . Tools::getSubValue('return_name', $v, '') . '	' . Tools::getSubValue('return_type', $v, '') . '	' . Tools::getSubValue('return_title', $v, '') . '

'; return $html; } /** * 解析param 并生成HTML * @param array $data * @return string */ private function _getParamData($data = []) { $html = ''; if (!is_array($data) || count($data) < 1) { return $html; } $html .= '

请求参数

'; $html .= ''; foreach ($data as $v) { $html .= ''; } $html .= '

参数	类型	描述	默认值	是否必须
' . Tools::getSubValue('param_name', $v, '') . '	' . Tools::getSubValue('param_type', $v, '') . '	' . Tools::getSubValue('param_title', $v, '') . '	' . Tools::getSubValue('param_default', $v, '无默认值') . '	' . Tools::getSubValue('param_require', $v, '非必须') . '

'; return $html; } /** * 解析code 并生成HTML * @param array $data * @return string */ private function _getCodeData($data = []) { $html = ''; if (!is_array($data) || count($data) < 1) { return $html; } $html .= '

状态码说明

'; $html .= ''; foreach ($data as $v) { $html .= ''; } $html .= '

状态码	描述
' . Tools::getSubValue('code', $v, '') . '	' . Tools::getSubValue('content', $v, '暂无说明') . '

'; return $html; } /** * 获取指定接口操作下的文档信息 * @param $className - 类名 * @param $actionName - 操作名 * @param $actionItem - 接口数据 * @return string */ private function _getActionItem($className, $actionName, $actionItem) { $html = <<

API - {$actionItem['title']}

请求方式： {$actionItem['method']}

请求地址：{$actionItem['url']}

{$this->_getParamData(Tools::getSubValue('param', $actionItem, []))} {$this->_getReturnData(Tools::getSubValue('return', $actionItem, []))} {$this->_getCodeData(Tools::getSubValue('code', $actionItem, []))} EXT; return $html; } /** * 获取指定API类的文档HTML * @param $className - 类名称 * @param $classItem - 类数据 * @return string */ private function _getClassItem($className, $classItem) { $title = Tools::getSubValue('title', $classItem, '未命名'); $actionHtml = ''; if (isset($classItem['action']) && is_array($classItem['action']) && count($classItem['action']) >= 1) { foreach ($classItem['action'] as $actionName => $actionItem) { $actionHtml .= $this->_getActionItem($className, $actionName, $actionItem); } } $html = <<

{$title}

{$actionHtml}

EXT; return $html; } /** * 获取API文档HTML * @param array $data - 文档数据 * @return string */ private function _getDocList($data) { $html = ''; if (count($data) < 1) { return $html; } $html .= '

'; foreach ($data as $className => $classItem) { $html .= $this->_getClassItem($className, $classItem); } $html .= '

'; return $html; } /** * 获取顶部导航HTML * @param $data -API文档数据 * @return string */ private function _getTopNavList($data) { $html = '

'; $html .= '' . $title . ''; $html .= '
'; foreach ($classItem['action'] as $actionName => $actionItem) { $title = Tools::getSubValue('title', $actionItem, '未命名'); $id = $className . '_' . $actionName; $html .= '' . $title . ''; } $html .= '
下载文档

'; return $html; } /** * 获取文档CSS * @return string */ private function _getCss() { $path = realpath($this->bootstrapCss); if (!$path || !is_file($path)) { return $this->customCss; } $bootstrapCss = file_get_contents($path); if (empty($bootstrapCss)) { return $this->customCss; } $this->customCss = '' . $this->customCss; // $this->customCss = ' ' . $this->customCss; return $this->customCss; } /** * 获取文档JS * @return string */ private function _getJs() { // $js = ''; // $js .= ''; // $this->customJs = $js . $this->customJs; // return $this->customJs; $bootstrapJs = realpath($this->bootstrapJs); $jQueryJs = realpath($this->jQueryJs); if (!$bootstrapJs || !$jQueryJs || !is_file($bootstrapJs) || !is_file($jQueryJs)) { $this->customJs = ''; return $this->customCss; } $bootstrapJs = file_get_contents($bootstrapJs); $jQueryJs = file_get_contents($jQueryJs); if (empty($bootstrapJs) || empty($jQueryJs)) { $this->customJs = ''; return $this->customJs; } $js = '' . ''; $this->customJs = $js . $this->customJs; return $this->customJs; } }