1.3 添加替换符

.gitignore

@@ -0,0 +1 @@
+/vendor/

LICENSE

@@ -1,191 +1,21 @@
-Apache License
-Version 2.0, January 2004
-http://www.apache.org/licenses/
-
-TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-1. Definitions.
-
-"License" shall mean the terms and conditions for use, reproduction, and
-distribution as defined by Sections 1 through 9 of this document.
-
-"Licensor" shall mean the copyright owner or entity authorized by the copyright
-owner that is granting the License.
-
-"Legal Entity" shall mean the union of the acting entity and all other entities
-that control, are controlled by, or are under common control with that entity.
-For the purposes of this definition, "control" means (i) the power, direct or
-indirect, to cause the direction or management of such entity, whether by
-contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
-outstanding shares, or (iii) beneficial ownership of such entity.
-
-"You" (or "Your") shall mean an individual or Legal Entity exercising
-permissions granted by this License.
-
-"Source" form shall mean the preferred form for making modifications, including
-but not limited to software source code, documentation source, and configuration
-files.
-
-"Object" form shall mean any form resulting from mechanical transformation or
-translation of a Source form, including but not limited to compiled object code,
-generated documentation, and conversions to other media types.
-
-"Work" shall mean the work of authorship, whether in Source or Object form, made
-available under the License, as indicated by a copyright notice that is included
-in or attached to the work (an example is provided in the Appendix below).
-
-"Derivative Works" shall mean any work, whether in Source or Object form, that
-is based on (or derived from) the Work and for which the editorial revisions,
-annotations, elaborations, or other modifications represent, as a whole, an
-original work of authorship. For the purposes of this License, Derivative Works
-shall not include works that remain separable from, or merely link (or bind by
-name) to the interfaces of, the Work and Derivative Works thereof.
-
-"Contribution" shall mean any work of authorship, including the original version
-of the Work and any modifications or additions to that Work or Derivative Works
-thereof, that is intentionally submitted to Licensor for inclusion in the Work
-by the copyright owner or by an individual or Legal Entity authorized to submit
-on behalf of the copyright owner. For the purposes of this definition,
-"submitted" means any form of electronic, verbal, or written communication sent
-to the Licensor or its representatives, including but not limited to
-communication on electronic mailing lists, source code control systems, and
-issue tracking systems that are managed by, or on behalf of, the Licensor for
-the purpose of discussing and improving the Work, but excluding communication
-that is conspicuously marked or otherwise designated in writing by the copyright
-owner as "Not a Contribution."
-
-"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
-of whom a Contribution has been received by Licensor and subsequently
-incorporated within the Work.
-
-2. Grant of Copyright License.
-
-Subject to the terms and conditions of this License, each Contributor hereby
-grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
-irrevocable copyright license to reproduce, prepare Derivative Works of,
-publicly display, publicly perform, sublicense, and distribute the Work and such
-Derivative Works in Source or Object form.
-
-3. Grant of Patent License.
-
-Subject to the terms and conditions of this License, each Contributor hereby
-grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
-irrevocable (except as stated in this section) patent license to make, have
-made, use, offer to sell, sell, import, and otherwise transfer the Work, where
-such license applies only to those patent claims licensable by such Contributor
-that are necessarily infringed by their Contribution(s) alone or by combination
-of their Contribution(s) with the Work to which such Contribution(s) was
-submitted. If You institute patent litigation against any entity (including a
-cross-claim or counterclaim in a lawsuit) alleging that the Work or a
-Contribution incorporated within the Work constitutes direct or contributory
-patent infringement, then any patent licenses granted to You under this License
-for that Work shall terminate as of the date such litigation is filed.
-
-4. Redistribution.
-
-You may reproduce and distribute copies of the Work or Derivative Works thereof
-in any medium, with or without modifications, and in Source or Object form,
-provided that You meet the following conditions:
-
-You must give any other recipients of the Work or Derivative Works a copy of
-this License; and
-You must cause any modified files to carry prominent notices stating that You
-changed the files; and
-You must retain, in the Source form of any Derivative Works that You distribute,
-all copyright, patent, trademark, and attribution notices from the Source form
-of the Work, excluding those notices that do not pertain to any part of the
-Derivative Works; and
-If the Work includes a "NOTICE" text file as part of its distribution, then any
-Derivative Works that You distribute must include a readable copy of the
-attribution notices contained within such NOTICE file, excluding those notices
-that do not pertain to any part of the Derivative Works, in at least one of the
-following places: within a NOTICE text file distributed as part of the
-Derivative Works; within the Source form or documentation, if provided along
-with the Derivative Works; or, within a display generated by the Derivative
-Works, if and wherever such third-party notices normally appear. The contents of
-the NOTICE file are for informational purposes only and do not modify the
-License. You may add Your own attribution notices within Derivative Works that
-You distribute, alongside or as an addendum to the NOTICE text from the Work,
-provided that such additional attribution notices cannot be construed as
-modifying the License.
-You may add Your own copyright statement to Your modifications and may provide
-additional or different license terms and conditions for use, reproduction, or
-distribution of Your modifications, or for any such Derivative Works as a whole,
-provided Your use, reproduction, and distribution of the Work otherwise complies
-with the conditions stated in this License.
-
-5. Submission of Contributions.
-
-Unless You explicitly state otherwise, any Contribution intentionally submitted
-for inclusion in the Work by You to the Licensor shall be under the terms and
-conditions of this License, without any additional terms or conditions.
-Notwithstanding the above, nothing herein shall supersede or modify the terms of
-any separate license agreement you may have executed with Licensor regarding
-such Contributions.
-
-6. Trademarks.
-
-This License does not grant permission to use the trade names, trademarks,
-service marks, or product names of the Licensor, except as required for
-reasonable and customary use in describing the origin of the Work and
-reproducing the content of the NOTICE file.
-
-7. Disclaimer of Warranty.
-
-Unless required by applicable law or agreed to in writing, Licensor provides the
-Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
-including, without limitation, any warranties or conditions of TITLE,
-NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
-solely responsible for determining the appropriateness of using or
-redistributing the Work and assume any risks associated with Your exercise of
-permissions under this License.
-
-8. Limitation of Liability.
-
-In no event and under no legal theory, whether in tort (including negligence),
-contract, or otherwise, unless required by applicable law (such as deliberate
-and grossly negligent acts) or agreed to in writing, shall any Contributor be
-liable to You for damages, including any direct, indirect, special, incidental,
-or consequential damages of any character arising as a result of this License or
-out of the use or inability to use the Work (including but not limited to
-damages for loss of goodwill, work stoppage, computer failure or malfunction, or
-any and all other commercial damages or losses), even if such Contributor has
-been advised of the possibility of such damages.
-
-9. Accepting Warranty or Additional Liability.
-
-While redistributing the Work or Derivative Works thereof, You may choose to
-offer, and charge a fee for, acceptance of support, warranty, indemnity, or
-other liability obligations and/or rights consistent with this License. However,
-in accepting such obligations, You may act only on Your own behalf and on Your
-sole responsibility, not on behalf of any other Contributor, and only if You
-agree to indemnify, defend, and hold each Contributor harmless for any liability
-incurred by, or claims asserted against, such Contributor by reason of your
-accepting any such warranty or additional liability.
-
-END OF TERMS AND CONDITIONS
-
-APPENDIX: How to apply the Apache License to your work
-
-To apply the Apache License to your work, attach the following boilerplate
-notice, with the fields enclosed by brackets "{}" replaced with your own
-identifying information. (Don't include the brackets!) The text should be
-enclosed in the appropriate comment syntax for the file format. We also
-recommend that a file or class name and description of purpose be included on
-the same "printed page" as the copyright notice for easier identification within
-third-party archives.
-
-   Copyright 2017 dust9450
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
+The MIT License (MIT)
+
+Copyright (c) 2016 Arkadiusz Kondas <arkadiusz.kondas[at]gmail>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,7 @@
-# php注释自动生成api文档   v1.2
+# php注释自动生成api文档   v1.3
 作者: [Dust](http://dust101.lofter.com)  
 ----
+
 ## 注释示例:
 	与普通注释互不影响，要生成记得在第三行开头要有 api 请求方式 url 。  
     注释中备注不要有空格，建议使用标点符号来断句。  
@@ -15,7 +16,17 @@
      * @return array $void 结果
      */
     public function all($page,$limit){
-    	.....
+    	// 地址中新增两个占位符写法
+    	// api.php/index/{controller}/{method}
+    	// {method} 会自动换成对应的方法名
+    	// {controller} 会自动换成文件名(大驼峰会转成匈牙利)。
+    	//--------------------------------
+    	// 默认是文件名和方法名都开启大驼峰转换
+    	// 文件名是大写字母出现1次以及以上就转换
+    	// 方法名是大写字母出现2次以及以上就转换
+    	// 可以通过下面方法去改变,参数1是文件名,参数2是方法名
+	// $doc->setChange(true,true);
+	// $doc->setTime(1,2);
     }
 
     /**
@@ -75,7 +86,6 @@
  * 在线ajax  
  * 点击URL自动复制  
  * 兼容更低版本的PHP
- * 目录式
  * ...  
 
 ## 截图:

composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "mumbaicat/makeapidoc",
+    "description": "注释自动生成API文档",
+    "keywords": ["PHP","注释自动生成api文档"],
+    "homepage": "https://github.com/mumbaicat/makeapidoc",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Dust",
+            "email": "[email protected]"
+        }
+    ],
+    "autoload": {
+        "psr-0": {
+            "Phpml": "src/"
+        }
+    },
+    "require": {
+
+    }
+}

src/mumbaicat/apidoc/ApiDoc.php

@@ -8,6 +8,10 @@ class ApiDoc
     protected $documentPath;
     protected $savePath;
     protected $name = 'api';
+    protected $controllerChange = true;
+    protected $controllerTimes = 1;
+    protected $methodChange = true;
+    protected $methodTimes = 2;
 
     public function __construct($documentPath,$savePath=null)
     {
@@ -22,11 +26,53 @@ public function __construct($documentPath,$savePath=null)
     /**
      * 设置项目名称
      * @param string $name 项目名称
+     * @return void
      */
     public function setName($name){
         $this->name = $name;
     }
 
+    /**
+     * 设置是否开启驼峰转匈牙利
+     * @param bool $controller 文件名 true/false
+     * @param bool $method 方法名 true/false
+     * @return void
+     */
+    public function setChange($controller=true,$method=true){
+        $this->controllerChange = $controller;
+        $this->methodChange = $method;
+    }
+
+    /**
+     * 驼峰转匈牙利转换条件 (出现几次大写字母才转换)
+     * @param integer $controller 文件名
+     * @param integer $method 方法名
+     * @return void
+     */
+    public function setTimes($controller=1,$method=2){
+        $this->controllerTimes = $controller;
+        $this->methodTimes = $method;
+    }
+
+    /**
+     * 大驼峰命名法转匈牙利命名法
+     * @param string $str 字符串
+     * @param integer $times 出现几次大写字母才转换,默认1次
+     * @return string
+     */
+    private function humpToLine($str,$times=1){
+        if(preg_match_all('/[A-Z]/',$str) >= $times){
+            $str = preg_replace_callback('/([A-Z]{1})/',function($matches){
+                return '_'.strtolower($matches[0]);
+            },$str);
+            if($str[0]=='_'){
+                $str = substr_replace($str,'',0,1);
+            }
+            return $str;
+        }
+        return $str;
+    }
+
     /**
      * 递归法获取文件夹下文件
      * @param string $path 路径
@@ -72,10 +118,12 @@ private function catchEvery($data)
     /**
      * 解析每一条可以生成API文档的注释成数组
      * @param string $data 注释文本 catchEvery返回的每个元素
+     * @param string $fileName 文件名
      * @return array
      */
-    private function parse($data)
+    private function parse($data,$fileName)
     {
+        $fileName = basename($fileName,'.php');
         $return = [];
         preg_match_all('/(public|private|protected)?\s*function\s+(.*?)\(/', $data, $matches);
         $return['funcName'] = !empty($matches[2][0]) ? $matches[2][0] : '[null]';
@@ -84,6 +132,14 @@ private function parse($data)
         preg_match_all('/\s+\*\s+api\s+(.*?)\s+(.*?)\s+(\s+\*\s+@)?.*/', $data, $matches);
         $return['requestName'] = !empty($matches[1][0]) ? $matches[1][0] : '[null]';
         $return['requestUrl'] = !empty($matches[2][0]) ? $matches[2][0] : '[null]';
+
+        if($this->controllerChange == true){
+            $return['requestUrl'] = str_replace('{controller}',$this->humpToLine($fileName,$this->controllerTimes),$return['requestUrl']);
+        }
+        if($this->methodChange == true){
+            $return['requestUrl'] = str_replace('{method}',$this->humpToLine($return['funcName'],$this->methodTimes),$return['requestUrl']);
+        }
+
         preg_match_all('/\s+\*\s+@param\s+(.*?)\s+(.*?)\s+(.*?)\s/', $data, $matches);
         if(empty($matches[1])){
             $return['param'] = [];
@@ -251,7 +307,7 @@ public function make($fetch=false)
             $fileData = file_get_contents($fileName);
             $data = $this->catchEvery($fileData);
             foreach ($data as $one) {
-                $infoData = $this->parse($one);
+                $infoData = $this->parse($one,$fileName);
                 $rightList[basename($fileName)][] = [
                     'methodName' => $infoData['methodName'],
                     'requestUrl' => $infoData['requestUrl'],