online docs with tpl path

phalapi · Nov 22, 2017 · ac3c42e · ac3c42e
1 parent 8b181e0
commit ac3c42e
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 8 deletions.
diff --git a/src/app/Api/Examples/QrCode.php b/src/app/Api/Examples/QrCode.php
@@ -4,7 +4,7 @@
 use PhalApi\Api;
 
 /**
- * 生成二维码 (免签名)
+ * 生成二维码
  */
 class QrCode extends Api {
 

diff --git a/vendor/phalapi/kernal/src/Helper/ApiDesc.php b/vendor/phalapi/kernal/src/Helper/ApiDesc.php
@@ -16,8 +16,8 @@
 
 class ApiDesc extends ApiOnline {
 
-    public function render() {
-        parent::render();
+    public function render($tplPath = NULL) {
+        parent::render($tplPath);
 
         $service    = \PhalApi\DI()->request->getService();
         $namespace  = \PhalApi\DI()->request->getNamespace();
@@ -112,6 +112,7 @@ public function render() {
             $returns[$returnCommentArr[1]] = $returnCommentArr; 
         }
 
-        include dirname(__FILE__) . '/api_desc_tpl.php';
+        $tplPath = !empty($tplPath) ? $tplPath : dirname(__FILE__) . '/api_desc_tpl.php';
+        include $tplPath;
     }
 }
diff --git a/vendor/phalapi/kernal/src/Helper/ApiList.php b/vendor/phalapi/kernal/src/Helper/ApiList.php
@@ -5,10 +5,19 @@
 
 defined('D_S') || define('D_S', DIRECTORY_SEPARATOR);
 
+/**
+ * ApiList - 在线接口列表文档 - 辅助类
+ *
+ * @package     PhalApi\Helper
+ * @license     http://www.phalapi.net/license GPL 协议
+ * @link        http://www.phalapi.net/
+ * @author      dogstar <chanzonghuang@gmail.com> 2017-11-22
+ */
+
 class ApiList extends ApiOnline {
 
-    public function render() {
-        parent::render();
+    public function render($tplPath = NULL) {
+        parent::render($tplPath);
 
         $composerJson = file_get_contents(API_ROOT . D_S . 'composer.json');
         $composerArr = json_decode($composerJson, TRUE);
@@ -146,7 +155,8 @@ public function render() {
 
         $projectName = $this->projectName;
 
-        include dirname(__FILE__) . '/api_list_tpl.php';
+        $tplPath = !empty($tplPath) ? $tplPath : dirname(__FILE__) . '/api_list_tpl.php';
+        include $tplPath;
     }
 }
 

diff --git a/vendor/phalapi/kernal/src/Helper/ApiOnline.php b/vendor/phalapi/kernal/src/Helper/ApiOnline.php
@@ -1,6 +1,15 @@
 <?php
 namespace PhalApi\Helper;
 
+/**
+ * ApiOnline - 在线接口文档
+ *     
+ * @package     PhalApi\Helper
+ * @license     http://www.phalapi.net/license GPL 协议
+ * @link        http://www.phalapi.net/
+ * @author      dogstar <chanzonghuang@gmail.com> 2017-11-22
+ */
+
 class ApiOnline {
 
     protected $projectName;
@@ -9,7 +18,10 @@ public function __construct($projectName) {
         $this->projectName = $projectName;
     }
 
-    public function render() {
+    /**
+     * @param string $tplPath 模板绝对路径
+     */
+    public function render($tplPath = NULL) {
         header('Content-Type:text/html;charset=utf-8');
     }
 }