20220406

vendor/itxq/api-doc-php/test/Api.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ *  ==================================================================
+ *        文 件 名: Api.php
+ *        概    要:
+ *        作    者: IT小强
+ *        创建时间: 2018/6/5 9:43
+ *        修改时间:
+ *        copyright (c) 2016 - 2018 mail@xqitw.cn
+ *  ==================================================================
+ */
+
+/**
+ * @title 登录注册
+ * Class Api
+ */
+class Api
+{
+    /**
+     * @title 用户登录API
+     * @url https://wwww.baidu.com/login
+     * @method POST
+     * @param string username 账号 空 必须
+     * @param string password 密码 空 必须
+     * @code 1 成功
+     * @code 2 失败
+     * @return int code 状态码（具体参见状态码说明）
+     * @return string msg 提示信息
+     */
+    public function login() {
+        return json_encode(['code' => 1, 'msg' => '登录成功']);
+    }
+    
+    /**
+     * @title 用户注册API
+     * @url https://wwww.baidu.com/reg
+     * @method POST
+     * @param string username 账号 空 必须
+     * @param string password 密码 空 必须
+     * @param string password2 重复密码 空 必须
+     * @code 1 成功
+     * @code 2 失败
+     * @return int code 状态码（具体参见状态码说明）
+     * @return string msg 提示信息
+     */
+    public function reg() {
+        return json_encode(['code' => 1, 'msg' => '注册成功']);
+    }
+}

vendor/itxq/api-doc-php/test/Api2.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ *  ==================================================================
+ *        文 件 名: Api2.php
+ *        概    要:
+ *        作    者: IT小强
+ *        创建时间: 2018/6/6 9:17
+ *        修改时间:
+ *        copyright (c) 2016 - 2018 mail@xqitw.cn
+ *  ==================================================================
+ */
+
+/**
+ * @title 用户相关
+ * Class Api
+ */
+class Api2
+{
+    /**
+     * @title 获取用户信息
+     * @url https://wwww.baidu.com/getuserinfo
+     * @method GET
+     * @param int uid 用户ID 0 必须
+     * @param string token 令牌 空 必须
+     * @code 1 成功
+     * @code 2 失败
+     * @return int code 状态码（具体参见状态码说明）
+     * @return string msg 提示信息
+     */
+    public function getUserInfo() {
+        return json_encode(['code' => 1, 'msg' => '获取信息成功', 'data' => ['uid' => 1, 'username' => 'admin']]);
+    }
+}

vendor/itxq/api-doc-php/test/index.php

@@ -0,0 +1,22 @@
+<?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\BootstrapApiDoc($config);
+$doc = $api->getHtml();
+exit($doc);
+