From 5781e68d6edc991b98e230c74c27ad7747df95d5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?IT=E5=B0=8F=E5=BC=BAxqitw=2Ecn?= <360237521@qq.com>
Date: Wed, 6 Jun 2018 13:41:31 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=E6=B5=8B=E8=AF=95=E7=9B=AE?=
 =?UTF-8?q?=E5=BD=95=EF=BC=8C=E4=BB=85=E4=BE=9B=E5=8F=82=E8=80=83?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .gitignore     |   1 -
 README.md      |   3 +-
 test/Api.php   |  38 ++++++++++++++
 test/Api2.php  |  49 ++++++++++++++++++
 test/index.php | 132 +++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 221 insertions(+), 2 deletions(-)
 create mode 100644 test/Api.php
 create mode 100644 test/Api2.php
 create mode 100644 test/index.php

diff --git a/.gitignore b/.gitignore
index 2c0386c..c7e0800 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,3 @@
 /.idea
-/test/
 /vendor/
 /composer.lock
\ No newline at end of file
diff --git a/README.md b/README.md
index b822e0d..ea91dd0 100644
--- a/README.md
+++ b/README.md
@@ -40,4 +40,5 @@ $doc = $api->getApiDoc();
 echo '<pre>';
 var_dump($doc);
 echo '</pre>';
-```
\ No newline at end of file
+```
++ 具体使用可参见test目录
\ No newline at end of file
diff --git a/test/Api.php b/test/Api.php
new file mode 100644
index 0000000..41fefad
--- /dev/null
+++ b/test/Api.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ *  ==================================================================
+ *        文 件 名: Api.php
+ *        概    要:
+ *        作    者: IT小强
+ *        创建时间: 2018/6/5 9:43
+ *        修改时间:
+ *        copyright (c) 2016 - 2018 mail@xqitw.cn
+ *  ==================================================================
+ */
+
+/**
+ * @title 测试用的API类
+ * Class Api
+ */
+class Api
+{
+    /**
+     * @title 添加操作
+     * @url https://wwww.baidu.com
+     * @method POST
+     * @param array|string|bool id 用户ID null 必须
+     * @param array|string|bool id2 用户ID2 false 非必须
+     * @code 1 成功
+     * @code 2 失败
+     * @return int code 状态码（具体参见状态码说明）
+     * @return string msg 提示信息
+     * @return object data 返回的数据
+     */
+    public function add() {
+    
+    }
+    
+    public function edit() {
+    
+    }
+}
\ No newline at end of file
diff --git a/test/Api2.php b/test/Api2.php
new file mode 100644
index 0000000..3ef0ef3
--- /dev/null
+++ b/test/Api2.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ *  ==================================================================
+ *        文 件 名: Api2.php
+ *        概    要:
+ *        作    者: IT小强
+ *        创建时间: 2018/6/6 9:17
+ *        修改时间:
+ *        copyright (c) 2016 - 2018 mail@xqitw.cn
+ *  ==================================================================
+ */
+/**
+ * @title 测试用的API类2
+ * Class Api
+ */
+class Api2
+{
+    /**
+     * @title 添加操作
+     * @url https://wwww.baidu.com
+     * @method POST
+     * @param array|string|bool id 用户ID null 必须
+     * @param array|string|bool id2 用户ID2 false 非必须
+     * @code 1 成功
+     * @code 2 失败
+     * @return int code 状态码（具体参见状态码说明）
+     * @return string msg 提示信息
+     * @return object data 返回的数据
+     */
+    public function addxx() {
+    
+    }
+    
+    /**
+     * @title 添加操作
+     * @url https://wwww.baidu.com
+     * @method POST
+     * @param array|string|bool id 用户ID null 必须
+     * @param array|string|bool id2 用户ID2 false 非必须
+     * @code 1 成功
+     * @code 2 失败
+     * @return int code 状态码（具体参见状态码说明）
+     * @return string msg 提示信息
+     * @return object data 返回的数据
+     */
+    public function editcccc() {
+    
+    }
+}
\ No newline at end of file
diff --git a/test/index.php b/test/index.php
new file mode 100644
index 0000000..0b67d45
--- /dev/null
+++ b/test/index.php
@@ -0,0 +1,132 @@
+<?php
+/**
+ *  ==================================================================
+ *        文 件 名: index.php
+ *        概    要: API文档 By Api-Doc-PHP
+ *        作    者: IT小强
+ *        创建时间: 2018/6/5 9:48
+ *        修改时间:
+ *        copyright (c) 2016 - 2018 mail@xqitw.cn
+ *  ==================================================================
+ */
+require_once __DIR__ . '/../vendor/autoload.php';
+require_once __DIR__ . '/Api.php'; // 加载测试API类1
+require_once __DIR__ . '/Api2.php'; // 加载测试API类2
+$config = [
+    'class'         => ['Api', 'Api2'], // 要生成文档的类
+    'filter_method' => ['__construct'], // 要过滤的方法名称
+];
+$api = new \itxq\apidoc\ApiDoc($config);
+$doc = $api->getApiDoc();
+?>
+<!DOCTYPE html>
+<html lang="zh-CN">
+<head>
+    <meta charset="utf-8">
+    <meta name="renderer" content="webkit">
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
+    <!-- 禁止浏览器初始缩放 -->
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, maximum-scale=1, user-scalable=0">
+    <title>API文档 By Api-Doc-PHP</title>
+    <link href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/css/bootstrap.min.css" rel="stylesheet">
+    <style type="text/css">
+        .class-item .class-title {
+            text-indent: 0.6em;
+            border-left: 5px solid lightseagreen;
+            font-size: 24px;
+            margin: 10px 0;
+        }
+        
+        .action-item .action-title {
+            text-indent: 0.6em;
+            border-left: 3px solid #F0AD4E;
+            font-size: 20px;
+            margin: 8px 0;
+        }
+        
+        .table-item {
+            background-color: #F1F1F1;
+            padding-top: 10px;
+        }
+    </style>
+</head>
+<body>
+<div class="container">
+    <?php foreach ($doc as $className => $classItem) { ?>
+        <div class="row">
+            <div class="class-item col-md-12" id="<?php echo $className; ?>">
+                <h2 class="class-title">
+                    <?php echo $classItem['title']; ?>
+                </h2>
+                <hr>
+                <?php foreach ($classItem['action'] as $actionName => $actionItem) { ?>
+                    <div class="action-item  col-md-12" id="<?php echo $className; ?>-<?php echo $actionName; ?>">
+                        <h4 class="action-title">API - <?php echo $actionItem['title']; ?></h4>
+                        <p>请求方式：
+                            <span class="btn btn-info btn-sm"><?php echo $actionItem['method']; ?></span>
+                        </p>
+                        <p>请求地址：<a href="<?php echo $actionItem['url']; ?>"><?php echo $actionItem['url']; ?></a></p>
+                        <div class="table-item col-md-12">
+                            <p class="table-title"><span class="btn  btn-sm btn-danger">body参数</span></p>
+                            <table class="table">
+                                <tr>
+                                    <td>参数</td>
+                                    <td>类型</td>
+                                    <td>描述</td>
+                                    <td>默认值</td>
+                                    <td>是否必须</td>
+                                </tr>
+                                <?php foreach ($actionItem['param'] as $param) { ?>
+                                    <tr>
+                                        <td><?php echo $param['param_name']; ?></td>
+                                        <td><?php echo $param['param_type']; ?></td>
+                                        <td><?php echo $param['param_title']; ?></td>
+                                        <td><?php echo $param['param_default']; ?></td>
+                                        <td><?php echo $param['param_require']; ?></td>
+                                    </tr>
+                                <?php } ?>
+                            </table>
+                        </div>
+                        <div class="table-item col-md-12">
+                            <p class="table-title"><span class="btn  btn-sm btn-warning">状态码说明</span></p>
+                            <table class="table">
+                                <tr>
+                                    <td>状态码</td>
+                                    <td>描述</td>
+                                </tr>
+                                <?php foreach ($actionItem['code'] as $code) { ?>
+                                    <tr>
+                                        <td><?php echo $code['code']; ?></td>
+                                        <td><?php echo $code['content']; ?></td>
+                                    </tr>
+                                <?php } ?>
+                            </table>
+                        </div>
+                        <div class="table-item col-md-12">
+                            <p class="table-title"><span class="btn  btn-sm btn-success">返回参数</span></p>
+                            <table class="table">
+                                <tr>
+                                    <td>参数</td>
+                                    <td>类型</td>
+                                    <td>描述</td>
+                                </tr>
+                                <?php foreach ($actionItem['return'] as $return) { ?>
+                                    <tr>
+                                        <td><?php echo $return['return_name']; ?></td>
+                                        <td><?php echo $return['return_type']; ?></td>
+                                        <td><?php echo $return['return_title']; ?></td>
+                                    </tr>
+                                <?php } ?>
+                            </table>
+                        </div>
+                    </div>
+                <?php } ?>
+            </div>
+        </div>
+    <?php } ?>
+</div>
+<script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js" type="text/javascript"></script>
+<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/js/bootstrap.min.js" type="text/javascript"></script>
+</body>
+</html>
+