Store the customized Shopro mall so it can be kept on the remote.
Co-authored-by: Cursor <cursoragent@cursor.com>
这个提交包含在：
wikiboss
@@ -0,0 +1,25 @@
|
||||
<?php
|
||||
|
||||
return [
|
||||
'Info' => '基础信息',
|
||||
'Sandbox' => '在线测试',
|
||||
'Sampleoutput' => '返回示例',
|
||||
'Headers' => 'Headers',
|
||||
'Parameters' => '参数',
|
||||
'Body' => '正文',
|
||||
'Name' => '名称',
|
||||
'Type' => '类型',
|
||||
'Required' => '必选',
|
||||
'Description' => '描述',
|
||||
'Send' => '提交',
|
||||
'Reset' => '重置',
|
||||
'Tokentips' => 'Token在会员注册或登录后都会返回,WEB端同时存在于Cookie中',
|
||||
'Apiurltips' => 'API接口URL',
|
||||
'Savetips' => '点击保存后Token和Api url都将保存在本地Localstorage中',
|
||||
'Authorization' => '权限',
|
||||
'NeedLogin' => '登录',
|
||||
'NeedRight' => '鉴权',
|
||||
'ReturnHeaders' => '响应头',
|
||||
'ReturnParameters' => '返回参数',
|
||||
'Response' => '响应输出',
|
||||
];
|
||||
@@ -0,0 +1,259 @@
|
||||
<?php
|
||||
|
||||
namespace app\admin\command\Api\library;
|
||||
|
||||
use think\Config;
|
||||
|
||||
/**
|
||||
* @website https://github.com/calinrada/php-apidoc
|
||||
* @author Calin Rada <rada.calin@gmail.com>
|
||||
* @author Karson <karson@fastadmin.net>
|
||||
*/
|
||||
class Builder
|
||||
{
|
||||
|
||||
/**
|
||||
*
|
||||
* @var \think\View
|
||||
*/
|
||||
public $view = null;
|
||||
|
||||
/**
|
||||
* parse classes
|
||||
* @var array
|
||||
*/
|
||||
protected $classes = [];
|
||||
|
||||
/**
|
||||
*
|
||||
* @param array $classes
|
||||
*/
|
||||
public function __construct($classes = [])
|
||||
{
|
||||
$this->classes = array_merge($this->classes, $classes);
|
||||
$this->view = new \think\View(Config::get('template'), Config::get('view_replace_str'));
|
||||
}
|
||||
|
||||
protected function extractAnnotations()
|
||||
{
|
||||
foreach ($this->classes as $class) {
|
||||
$classAnnotation = Extractor::getClassAnnotations($class);
|
||||
// 如果忽略
|
||||
if (isset($classAnnotation['ApiInternal'])) {
|
||||
continue;
|
||||
}
|
||||
Extractor::getClassMethodAnnotations($class);
|
||||
//Extractor::getClassPropertyValues($class);
|
||||
}
|
||||
$allClassAnnotation = Extractor::getAllClassAnnotations();
|
||||
$allClassMethodAnnotation = Extractor::getAllClassMethodAnnotations();
|
||||
//$allClassPropertyValue = Extractor::getAllClassPropertyValues();
|
||||
|
||||
// foreach ($allClassMethodAnnotation as $className => &$methods) {
|
||||
// foreach ($methods as &$method) {
|
||||
// //权重判断
|
||||
// if ($method && !isset($method['ApiWeigh']) && isset($allClassAnnotation[$className]['ApiWeigh'])) {
|
||||
// $method['ApiWeigh'] = $allClassAnnotation[$className]['ApiWeigh'];
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
// unset($methods);
|
||||
return [$allClassAnnotation, $allClassMethodAnnotation];
|
||||
}
|
||||
|
||||
protected function generateHeadersTemplate($docs)
|
||||
{
|
||||
if (!isset($docs['ApiHeaders'])) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$headerslist = array();
|
||||
foreach ($docs['ApiHeaders'] as $params) {
|
||||
$tr = array(
|
||||
'name' => $params['name'] ?? '',
|
||||
'type' => $params['type'] ?? 'string',
|
||||
'sample' => $params['sample'] ?? '',
|
||||
'required' => $params['required'] ?? false,
|
||||
'description' => $params['description'] ?? '',
|
||||
);
|
||||
$headerslist[] = $tr;
|
||||
}
|
||||
|
||||
return $headerslist;
|
||||
}
|
||||
|
||||
protected function generateParamsTemplate($docs)
|
||||
{
|
||||
if (!isset($docs['ApiParams'])) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$typeArr = [
|
||||
'integer' => 'number',
|
||||
'file' => 'file',
|
||||
];
|
||||
$paramslist = array();
|
||||
foreach ($docs['ApiParams'] as $params) {
|
||||
$type = strtolower($params['type'] ?? 'string');
|
||||
$inputtype = $typeArr[$type] ?? ($params['name'] == 'password' ? 'password' : 'text');
|
||||
$tr = array(
|
||||
'name' => $params['name'],
|
||||
'type' => $type,
|
||||
'inputtype' => $inputtype,
|
||||
'sample' => $params['sample'] ?? '',
|
||||
'required' => $params['required'] ?? true,
|
||||
'description' => $params['description'] ?? '',
|
||||
);
|
||||
$paramslist[] = $tr;
|
||||
}
|
||||
|
||||
return $paramslist;
|
||||
}
|
||||
|
||||
protected function generateReturnHeadersTemplate($docs)
|
||||
{
|
||||
if (!isset($docs['ApiReturnHeaders'])) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$headerslist = array();
|
||||
foreach ($docs['ApiReturnHeaders'] as $params) {
|
||||
$tr = array(
|
||||
'name' => $params['name'] ?? '',
|
||||
'type' => 'string',
|
||||
'sample' => $params['sample'] ?? '',
|
||||
'required' => isset($params['required']) && $params['required'] ? 'Yes' : 'No',
|
||||
'description' => $params['description'] ?? '',
|
||||
);
|
||||
$headerslist[] = $tr;
|
||||
}
|
||||
|
||||
return $headerslist;
|
||||
}
|
||||
|
||||
protected function generateReturnParamsTemplate($st_params)
|
||||
{
|
||||
if (!isset($st_params['ApiReturnParams'])) {
|
||||
return [];
|
||||
}
|
||||
|
||||
$paramslist = array();
|
||||
foreach ($st_params['ApiReturnParams'] as $params) {
|
||||
$tr = array(
|
||||
'name' => $params['name'] ?? '',
|
||||
'type' => $params['type'] ?? 'string',
|
||||
'sample' => $params['sample'] ?? '',
|
||||
'description' => $params['description'] ?? '',
|
||||
);
|
||||
$paramslist[] = $tr;
|
||||
}
|
||||
|
||||
return $paramslist;
|
||||
}
|
||||
|
||||
protected function generateBadgeForMethod($data)
|
||||
{
|
||||
$method = strtoupper(is_array($data['ApiMethod'][0]) ? $data['ApiMethod'][0]['data'] : $data['ApiMethod'][0]);
|
||||
$labes = array(
|
||||
'POST' => 'label-primary',
|
||||
'GET' => 'label-success',
|
||||
'PUT' => 'label-warning',
|
||||
'DELETE' => 'label-danger',
|
||||
'PATCH' => 'label-default',
|
||||
'OPTIONS' => 'label-info'
|
||||
);
|
||||
|
||||
return $labes[$method] ?? $labes['GET'];
|
||||
}
|
||||
|
||||
public function parse()
|
||||
{
|
||||
list($allClassAnnotations, $allClassMethodAnnotations) = $this->extractAnnotations();
|
||||
|
||||
$sectorArr = [];
|
||||
foreach ($allClassAnnotations as $index => &$allClassAnnotation) {
|
||||
// 如果设置隐藏，则不显示在文档
|
||||
if (isset($allClassAnnotation['ApiInternal'])) {
|
||||
continue;
|
||||
}
|
||||
$sector = isset($allClassAnnotation['ApiSector']) ? $allClassAnnotation['ApiSector'][0] : $allClassAnnotation['ApiTitle'][0];
|
||||
$sectorArr[$sector] = isset($allClassAnnotation['ApiWeigh']) ? $allClassAnnotation['ApiWeigh'][0] : 0;
|
||||
}
|
||||
unset($allClassAnnotation);
|
||||
|
||||
arsort($sectorArr);
|
||||
$routes = include_once CONF_PATH . 'route.php';
|
||||
$subdomain = false;
|
||||
if (config('url_domain_deploy') && isset($routes['__domain__']) && isset($routes['__domain__']['api']) && $routes['__domain__']['api']) {
|
||||
$subdomain = true;
|
||||
}
|
||||
$counter = 0;
|
||||
$section = null;
|
||||
$weigh = 0;
|
||||
$docsList = [];
|
||||
foreach ($allClassMethodAnnotations as $class => $methods) {
|
||||
foreach ($methods as $name => $docs) {
|
||||
if (isset($docs['ApiSector'][0])) {
|
||||
$section = is_array($docs['ApiSector'][0]) ? $docs['ApiSector'][0]['data'] : $docs['ApiSector'][0];
|
||||
} else {
|
||||
$section = $class;
|
||||
}
|
||||
if (0 === count($docs)) {
|
||||
continue;
|
||||
}
|
||||
$route = is_array($docs['ApiRoute'][0]) ? $docs['ApiRoute'][0]['data'] : $docs['ApiRoute'][0];
|
||||
if ($subdomain) {
|
||||
$route = substr($route, 4);
|
||||
}
|
||||
$docsList[$section][$name] = [
|
||||
'id' => $counter,
|
||||
'method' => is_array($docs['ApiMethod'][0]) ? $docs['ApiMethod'][0]['data'] : $docs['ApiMethod'][0],
|
||||
'methodLabel' => $this->generateBadgeForMethod($docs),
|
||||
'section' => $section,
|
||||
'route' => $route,
|
||||
'title' => is_array($docs['ApiTitle'][0]) ? $docs['ApiTitle'][0]['data'] : $docs['ApiTitle'][0],
|
||||
'summary' => is_array($docs['ApiSummary'][0]) ? $docs['ApiSummary'][0]['data'] : $docs['ApiSummary'][0],
|
||||
'body' => isset($docs['ApiBody'][0]) ? (is_array($docs['ApiBody'][0]) ? $docs['ApiBody'][0]['data'] : $docs['ApiBody'][0]) : '',
|
||||
'headersList' => $this->generateHeadersTemplate($docs),
|
||||
'paramsList' => $this->generateParamsTemplate($docs),
|
||||
'returnHeadersList' => $this->generateReturnHeadersTemplate($docs),
|
||||
'returnParamsList' => $this->generateReturnParamsTemplate($docs),
|
||||
'weigh' => is_array($docs['ApiWeigh'][0]) ? $docs['ApiWeigh'][0]['data'] : $docs['ApiWeigh'][0],
|
||||
'return' => isset($docs['ApiReturn']) ? (is_array($docs['ApiReturn'][0]) ? $docs['ApiReturn'][0]['data'] : $docs['ApiReturn'][0]) : '',
|
||||
'needLogin' => $docs['ApiPermissionLogin'][0],
|
||||
'needRight' => $docs['ApiPermissionRight'][0],
|
||||
];
|
||||
$counter++;
|
||||
}
|
||||
}
|
||||
|
||||
//重建排序
|
||||
foreach ($docsList as $index => &$methods) {
|
||||
$methodSectorArr = [];
|
||||
foreach ($methods as $name => $method) {
|
||||
$methodSectorArr[$name] = $method['weigh'] ?? 0;
|
||||
}
|
||||
arsort($methodSectorArr);
|
||||
$methods = array_merge(array_flip(array_keys($methodSectorArr)), $methods);
|
||||
}
|
||||
$docsList = array_merge(array_flip(array_keys($sectorArr)), $docsList);
|
||||
return $docsList;
|
||||
}
|
||||
|
||||
public function getView()
|
||||
{
|
||||
return $this->view;
|
||||
}
|
||||
|
||||
/**
|
||||
* 渲染
|
||||
* @param string $template
|
||||
* @param array $vars
|
||||
* @return string
|
||||
*/
|
||||
public function render($template, $vars = [])
|
||||
{
|
||||
$docsList = $this->parse();
|
||||
return $this->view->display(file_get_contents($template), array_merge($vars, ['docsList' => $docsList]));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,544 @@
|
||||
<?php
|
||||
|
||||
namespace app\admin\command\Api\library;
|
||||
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Class imported from https://github.com/eriknyk/Annotations
|
||||
* @author Erik Amaru Ortiz https://github.com/eriknyk
|
||||
*
|
||||
* @license http://opensource.org/licenses/bsd-license.php The BSD License
|
||||
* @author Calin Rada <rada.calin@gmail.com>
|
||||
*/
|
||||
class Extractor
|
||||
{
|
||||
|
||||
/**
|
||||
* Static array to store already parsed annotations
|
||||
* @var array
|
||||
*/
|
||||
private static $annotationCache;
|
||||
|
||||
private static $classAnnotationCache;
|
||||
|
||||
private static $classMethodAnnotationCache;
|
||||
|
||||
private static $classPropertyValueCache;
|
||||
|
||||
/**
|
||||
* Indicates that annotations should has strict behavior, 'false' by default
|
||||
* @var boolean
|
||||
*/
|
||||
private $strict = false;
|
||||
|
||||
/**
|
||||
* Stores the default namespace for Objects instance, usually used on methods like getMethodAnnotationsObjects()
|
||||
* @var string
|
||||
*/
|
||||
public $defaultNamespace = '';
|
||||
|
||||
/**
|
||||
* Sets strict variable to true/false
|
||||
* @param bool $value boolean value to indicate that annotations to has strict behavior
|
||||
*/
|
||||
public function setStrict($value)
|
||||
{
|
||||
$this->strict = (bool)$value;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets default namespace to use in object instantiation
|
||||
* @param string $namespace default namespace
|
||||
*/
|
||||
public function setDefaultNamespace($namespace)
|
||||
{
|
||||
$this->defaultNamespace = $namespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets default namespace used in object instantiation
|
||||
* @return string $namespace default namespace
|
||||
*/
|
||||
public function getDefaultAnnotationNamespace()
|
||||
{
|
||||
return $this->defaultNamespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all anotations with pattern @SomeAnnotation() from a given class
|
||||
*
|
||||
* @param string $className class name to get annotations
|
||||
* @return array self::$classAnnotationCache all annotated elements
|
||||
*/
|
||||
public static function getClassAnnotations($className)
|
||||
{
|
||||
if (!isset(self::$classAnnotationCache[$className])) {
|
||||
$class = new \ReflectionClass($className);
|
||||
$annotationArr = self::parseAnnotations($class->getDocComment());
|
||||
$annotationArr['ApiTitle'] = !isset($annotationArr['ApiTitle'][0]) || !trim($annotationArr['ApiTitle'][0]) ? [$class->getShortName()] : $annotationArr['ApiTitle'];
|
||||
self::$classAnnotationCache[$className] = $annotationArr;
|
||||
}
|
||||
|
||||
return self::$classAnnotationCache[$className];
|
||||
}
|
||||
|
||||
/**
|
||||
* 获取类所有方法的属性配置
|
||||
* @param $className
|
||||
* @return mixed
|
||||
* @throws \ReflectionException
|
||||
*/
|
||||
public static function getClassMethodAnnotations($className)
|
||||
{
|
||||
$class = new \ReflectionClass($className);
|
||||
|
||||
foreach ($class->getMethods() as $object) {
|
||||
self::$classMethodAnnotationCache[$className][$object->name] = self::getMethodAnnotations($className, $object->name);
|
||||
}
|
||||
|
||||
return self::$classMethodAnnotationCache[$className];
|
||||
}
|
||||
|
||||
public static function getClassPropertyValues($className)
|
||||
{
|
||||
$class = new \ReflectionClass($className);
|
||||
|
||||
foreach ($class->getProperties() as $object) {
|
||||
self::$classPropertyValueCache[$className][$object->name] = self::getClassPropertyValue($className, $object->name);
|
||||
}
|
||||
|
||||
return self::$classMethodAnnotationCache[$className];
|
||||
}
|
||||
|
||||
public static function getAllClassAnnotations()
|
||||
{
|
||||
return self::$classAnnotationCache;
|
||||
}
|
||||
|
||||
public static function getAllClassMethodAnnotations()
|
||||
{
|
||||
return self::$classMethodAnnotationCache;
|
||||
}
|
||||
|
||||
public static function getAllClassPropertyValues()
|
||||
{
|
||||
return self::$classPropertyValueCache;
|
||||
}
|
||||
|
||||
public static function getClassPropertyValue($className, $property)
|
||||
{
|
||||
$_SERVER['REQUEST_METHOD'] = 'GET';
|
||||
$reflectionClass = new \ReflectionClass($className);
|
||||
$reflectionProperty = $reflectionClass->getProperty($property);
|
||||
$reflectionProperty->setAccessible(true);
|
||||
return $reflectionProperty->getValue($reflectionClass->newInstanceWithoutConstructor());
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all anotations with pattern @SomeAnnotation() from a determinated method of a given class
|
||||
*
|
||||
* @param string $className class name
|
||||
* @param string $methodName method name to get annotations
|
||||
* @return array self::$annotationCache all annotated elements of a method given
|
||||
*/
|
||||
public static function getMethodAnnotations($className, $methodName)
|
||||
{
|
||||
if (!isset(self::$annotationCache[$className . '::' . $methodName])) {
|
||||
try {
|
||||
$method = new \ReflectionMethod($className, $methodName);
|
||||
$class = new \ReflectionClass($className);
|
||||
if (!$method->isPublic() || $method->isConstructor()) {
|
||||
$annotations = array();
|
||||
} else {
|
||||
$annotations = self::consolidateAnnotations($method, $class);
|
||||
}
|
||||
} catch (\ReflectionException $e) {
|
||||
$annotations = array();
|
||||
}
|
||||
|
||||
self::$annotationCache[$className . '::' . $methodName] = $annotations;
|
||||
}
|
||||
|
||||
return self::$annotationCache[$className . '::' . $methodName];
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all anotations with pattern @SomeAnnotation() from a determinated method of a given class
|
||||
* and instance its abcAnnotation class
|
||||
*
|
||||
* @param string $className class name
|
||||
* @param string $methodName method name to get annotations
|
||||
* @return array self::$annotationCache all annotated objects of a method given
|
||||
*/
|
||||
public function getMethodAnnotationsObjects($className, $methodName)
|
||||
{
|
||||
$annotations = $this->getMethodAnnotations($className, $methodName);
|
||||
$objects = array();
|
||||
|
||||
$i = 0;
|
||||
|
||||
foreach ($annotations as $annotationClass => $listParams) {
|
||||
$annotationClass = ucfirst($annotationClass);
|
||||
$class = $this->defaultNamespace . $annotationClass . 'Annotation';
|
||||
|
||||
// verify is the annotation class exists, depending if Annotations::strict is true
|
||||
// if not, just skip the annotation instance creation.
|
||||
if (!class_exists($class)) {
|
||||
if ($this->strict) {
|
||||
throw new Exception(sprintf('Runtime Error: Annotation Class Not Found: %s', $class));
|
||||
} else {
|
||||
// silent skip & continue
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
if (empty($objects[$annotationClass])) {
|
||||
$objects[$annotationClass] = new $class();
|
||||
}
|
||||
|
||||
foreach ($listParams as $params) {
|
||||
if (is_array($params)) {
|
||||
foreach ($params as $key => $value) {
|
||||
$objects[$annotationClass]->set($key, $value);
|
||||
}
|
||||
} else {
|
||||
$objects[$annotationClass]->set($i++, $params);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $objects;
|
||||
}
|
||||
|
||||
private static function consolidateAnnotations($method, $class)
|
||||
{
|
||||
$dockblockClass = $class->getDocComment();
|
||||
$docblockMethod = $method->getDocComment();
|
||||
$methodName = $method->getName();
|
||||
|
||||
$methodAnnotations = self::parseAnnotations($docblockMethod);
|
||||
$methodAnnotations['ApiTitle'] = !isset($methodAnnotations['ApiTitle'][0]) || !trim($methodAnnotations['ApiTitle'][0]) ? [$method->getName()] : $methodAnnotations['ApiTitle'];
|
||||
|
||||
$classAnnotations = self::parseAnnotations($dockblockClass);
|
||||
$classAnnotations['ApiTitle'] = !isset($classAnnotations['ApiTitle'][0]) || !trim($classAnnotations['ApiTitle'][0]) ? [$class->getShortName()] : $classAnnotations['ApiTitle'];
|
||||
|
||||
if (isset($methodAnnotations['ApiInternal']) || $methodName == '_initialize' || $methodName == '_empty') {
|
||||
return [];
|
||||
}
|
||||
|
||||
$properties = $class->getDefaultProperties();
|
||||
$noNeedLogin = isset($properties['noNeedLogin']) ? (is_array($properties['noNeedLogin']) ? $properties['noNeedLogin'] : [$properties['noNeedLogin']]) : [];
|
||||
$noNeedRight = isset($properties['noNeedRight']) ? (is_array($properties['noNeedRight']) ? $properties['noNeedRight'] : [$properties['noNeedRight']]) : [];
|
||||
|
||||
preg_match_all("/\*[\s]+(.*)(\\r\\n|\\r|\\n)/U", str_replace('/**', '', $docblockMethod), $methodArr);
|
||||
preg_match_all("/\*[\s]+(.*)(\\r\\n|\\r|\\n)/U", str_replace('/**', '', $dockblockClass), $classArr);
|
||||
|
||||
if (!isset($methodAnnotations['ApiMethod'])) {
|
||||
$methodAnnotations['ApiMethod'] = ['get'];
|
||||
}
|
||||
if (!isset($methodAnnotations['ApiWeigh'])) {
|
||||
$methodAnnotations['ApiWeigh'] = [0];
|
||||
}
|
||||
if (!isset($methodAnnotations['ApiSummary'])) {
|
||||
$methodAnnotations['ApiSummary'] = $methodAnnotations['ApiTitle'];
|
||||
}
|
||||
|
||||
if ($methodAnnotations) {
|
||||
foreach ($classAnnotations as $name => $valueClass) {
|
||||
if (count($valueClass) !== 1) {
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($name === 'ApiRoute') {
|
||||
if (isset($methodAnnotations[$name])) {
|
||||
$methodAnnotations[$name] = [rtrim($valueClass[0], '/') . $methodAnnotations[$name][0]];
|
||||
} else {
|
||||
$methodAnnotations[$name] = [rtrim($valueClass[0], '/') . '/' . $method->getName()];
|
||||
}
|
||||
}
|
||||
|
||||
if ($name === 'ApiSector') {
|
||||
$methodAnnotations[$name] = $valueClass;
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!isset($methodAnnotations['ApiRoute'])) {
|
||||
$urlArr = [];
|
||||
$className = $class->getName();
|
||||
|
||||
list($prefix, $suffix) = explode('\\' . \think\Config::get('url_controller_layer') . '\\', $className);
|
||||
$prefixArr = explode('\\', $prefix);
|
||||
$suffixArr = explode('\\', $suffix);
|
||||
if ($prefixArr[0] == \think\Config::get('app_namespace')) {
|
||||
$prefixArr[0] = '';
|
||||
}
|
||||
$urlArr = array_merge($urlArr, $prefixArr);
|
||||
$urlArr[] = implode('.', array_map(function ($item) {
|
||||
return \think\Loader::parseName($item);
|
||||
}, $suffixArr));
|
||||
$urlArr[] = $method->getName();
|
||||
|
||||
$methodAnnotations['ApiRoute'] = [implode('/', $urlArr)];
|
||||
}
|
||||
if (!isset($methodAnnotations['ApiSector'])) {
|
||||
$methodAnnotations['ApiSector'] = isset($classAnnotations['ApiSector']) ? $classAnnotations['ApiSector'] : $classAnnotations['ApiTitle'];
|
||||
}
|
||||
if (!isset($methodAnnotations['ApiParams'])) {
|
||||
$params = self::parseCustomAnnotations($docblockMethod, 'param');
|
||||
foreach ($params as $k => $v) {
|
||||
$arr = explode(' ', preg_replace("/[\s]+/", " ", $v));
|
||||
$methodAnnotations['ApiParams'][] = [
|
||||
'name' => isset($arr[1]) ? str_replace('$', '', $arr[1]) : '',
|
||||
'nullable' => false,
|
||||
'type' => isset($arr[0]) ? $arr[0] : 'string',
|
||||
'description' => isset($arr[2]) ? $arr[2] : ''
|
||||
];
|
||||
}
|
||||
}
|
||||
$methodAnnotations['ApiPermissionLogin'] = [!in_array('*', $noNeedLogin) && !in_array($methodName, $noNeedLogin)];
|
||||
$methodAnnotations['ApiPermissionRight'] = !$methodAnnotations['ApiPermissionLogin'][0] ? [false] : [!in_array('*', $noNeedRight) && !in_array($methodName, $noNeedRight)];
|
||||
return $methodAnnotations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse annotations
|
||||
*
|
||||
* @param string $docblock
|
||||
* @param string $name
|
||||
* @return array parsed annotations params
|
||||
*/
|
||||
private static function parseCustomAnnotations($docblock, $name = 'param')
|
||||
{
|
||||
$annotations = array();
|
||||
|
||||
$docblock = substr($docblock, 3, -2);
|
||||
if (preg_match_all('/@' . $name . '(?:\s*(?:\(\s*)?(.*?)(?:\s*\))?)??\s*(?:\n|\*\/)/', $docblock, $matches)) {
|
||||
foreach ($matches[1] as $k => $v) {
|
||||
$annotations[] = $v;
|
||||
}
|
||||
}
|
||||
return $annotations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse annotations
|
||||
*
|
||||
* @param string $docblock
|
||||
* @return array parsed annotations params
|
||||
*/
|
||||
private static function parseAnnotations($docblock)
|
||||
{
|
||||
$annotations = array();
|
||||
|
||||
// Strip away the docblock header and footer to ease parsing of one line annotations
|
||||
$docblock = substr($docblock, 3, -2);
|
||||
if (preg_match_all('/@(?<name>[A-Za-z_-]+)[\s\t]*\((?<args>(?:(?!\)).)*)\)\r?/s', $docblock, $matches)) {
|
||||
$numMatches = count($matches[0]);
|
||||
for ($i = 0; $i < $numMatches; ++$i) {
|
||||
$name = $matches['name'][$i];
|
||||
$value = '';
|
||||
// annotations has arguments
|
||||
if (isset($matches['args'][$i])) {
|
||||
$argsParts = trim($matches['args'][$i]);
|
||||
if ($name == 'ApiReturn') {
|
||||
$value = $argsParts;
|
||||
} elseif ($matches['args'][$i] != '') {
|
||||
$argsParts = preg_replace("/\{(\w+)\}/", '#$1#', $argsParts);
|
||||
$value = self::parseArgs($argsParts);
|
||||
if (is_string($value)) {
|
||||
$value = preg_replace("/\#(\w+)\#/", '{$1}', $argsParts);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$annotations[$name][] = $value;
|
||||
}
|
||||
}
|
||||
if (stripos($docblock, '@ApiInternal') !== false) {
|
||||
$annotations['ApiInternal'] = [true];
|
||||
}
|
||||
if (!isset($annotations['ApiTitle'])) {
|
||||
preg_match_all("/\*[\s]+(.*)(\\r\\n|\\r|\\n)/U", str_replace('/**', '', $docblock), $matchArr);
|
||||
$title = isset($matchArr[1]) && isset($matchArr[1][0]) ? $matchArr[1][0] : '';
|
||||
$annotations['ApiTitle'] = [$title];
|
||||
}
|
||||
|
||||
return $annotations;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse individual annotation arguments
|
||||
*
|
||||
* @param string $content arguments string
|
||||
* @return array annotated arguments
|
||||
*/
|
||||
private static function parseArgs($content)
|
||||
{
|
||||
// Replace initial stars
|
||||
$content = preg_replace('/^\s*\*/m', '', $content);
|
||||
|
||||
$data = array();
|
||||
$len = strlen($content);
|
||||
$i = 0;
|
||||
$var = '';
|
||||
$val = '';
|
||||
$level = 1;
|
||||
|
||||
$prevDelimiter = '';
|
||||
$nextDelimiter = '';
|
||||
$nextToken = '';
|
||||
$composing = false;
|
||||
$type = 'plain';
|
||||
$delimiter = null;
|
||||
$quoted = false;
|
||||
$tokens = array('"', '"', '{', '}', ',', '=');
|
||||
|
||||
while ($i <= $len) {
|
||||
$prev_c = substr($content, $i - 1, 1);
|
||||
$c = substr($content, $i++, 1);
|
||||
|
||||
if ($c === '"' && $prev_c !== "\\") {
|
||||
$delimiter = $c;
|
||||
//open delimiter
|
||||
if (!$composing && empty($prevDelimiter) && empty($nextDelimiter)) {
|
||||
$prevDelimiter = $nextDelimiter = $delimiter;
|
||||
$val = '';
|
||||
$composing = true;
|
||||
$quoted = true;
|
||||
} else {
|
||||
// close delimiter
|
||||
if ($c !== $nextDelimiter) {
|
||||
throw new Exception(sprintf(
|
||||
"Parse Error: enclosing error -> expected: [%s], given: [%s]",
|
||||
$nextDelimiter,
|
||||
$c
|
||||
));
|
||||
}
|
||||
|
||||
// validating syntax
|
||||
if ($i < $len) {
|
||||
if (',' !== substr($content, $i, 1) && '\\' !== $prev_c) {
|
||||
throw new Exception(sprintf(
|
||||
"Parse Error: missing comma separator near: ...%s<--",
|
||||
substr($content, ($i - 10), $i)
|
||||
));
|
||||
}
|
||||
}
|
||||
|
||||
$prevDelimiter = $nextDelimiter = '';
|
||||
$composing = false;
|
||||
$delimiter = null;
|
||||
}
|
||||
} elseif (!$composing && in_array($c, $tokens)) {
|
||||
switch ($c) {
|
||||
case '=':
|
||||
$prevDelimiter = $nextDelimiter = '';
|
||||
$level = 2;
|
||||
$composing = false;
|
||||
$type = 'assoc';
|
||||
$quoted = false;
|
||||
break;
|
||||
case ',':
|
||||
$level = 3;
|
||||
|
||||
// If composing flag is true yet,
|
||||
// it means that the string was not enclosed, so it is parsing error.
|
||||
if ($composing === true && !empty($prevDelimiter) && !empty($nextDelimiter)) {
|
||||
throw new Exception(sprintf(
|
||||
"Parse Error: enclosing error -> expected: [%s], given: [%s]",
|
||||
$nextDelimiter,
|
||||
$c
|
||||
));
|
||||
}
|
||||
|
||||
$prevDelimiter = $nextDelimiter = '';
|
||||
break;
|
||||
case '{':
|
||||
$subc = '';
|
||||
$subComposing = true;
|
||||
|
||||
while ($i <= $len) {
|
||||
$c = substr($content, $i++, 1);
|
||||
|
||||
if (isset($delimiter) && $c === $delimiter) {
|
||||
throw new Exception(sprintf(
|
||||
"Parse Error: Composite variable is not enclosed correctly."
|
||||
));
|
||||
}
|
||||
|
||||
if ($c === '}') {
|
||||
$subComposing = false;
|
||||
break;
|
||||
}
|
||||
$subc .= $c;
|
||||
}
|
||||
|
||||
// if the string is composing yet means that the structure of var. never was enclosed with '}'
|
||||
if ($subComposing) {
|
||||
throw new Exception(sprintf(
|
||||
"Parse Error: Composite variable is not enclosed correctly. near: ...%s'",
|
||||
$subc
|
||||
));
|
||||
}
|
||||
|
||||
$val = self::parseArgs($subc);
|
||||
break;
|
||||
}
|
||||
} else {
|
||||
if ($level == 1) {
|
||||
$var .= $c;
|
||||
} elseif ($level == 2) {
|
||||
$val .= $c;
|
||||
}
|
||||
}
|
||||
|
||||
if ($level === 3 || $i === $len) {
|
||||
if ($type == 'plain' && $i === $len) {
|
||||
$data = self::castValue($var);
|
||||
} else {
|
||||
$data[trim($var)] = self::castValue($val, !$quoted);
|
||||
}
|
||||
|
||||
$level = 1;
|
||||
$var = $val = '';
|
||||
$composing = false;
|
||||
$quoted = false;
|
||||
}
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Try determinate the original type variable of a string
|
||||
*
|
||||
* @param string $val string containing possibles variables that can be cast to bool or int
|
||||
* @param boolean $trim indicate if the value passed should be trimmed after to try cast
|
||||
* @return mixed returns the value converted to original type if was possible
|
||||
*/
|
||||
private static function castValue($val, $trim = false)
|
||||
{
|
||||
if (is_array($val)) {
|
||||
foreach ($val as $key => $value) {
|
||||
$val[$key] = self::castValue($value);
|
||||
}
|
||||
} elseif (is_string($val)) {
|
||||
if ($trim) {
|
||||
$val = trim($val);
|
||||
}
|
||||
$val = stripslashes($val);
|
||||
$tmp = strtolower($val);
|
||||
|
||||
if ($tmp === 'false' || $tmp === 'true') {
|
||||
$val = $tmp === 'true';
|
||||
} elseif (is_numeric($val)) {
|
||||
return $val + 0;
|
||||
}
|
||||
|
||||
unset($tmp);
|
||||
}
|
||||
|
||||
return $val;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,922 @@
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="description" content="">
|
||||
<title>{$config.title}</title>
|
||||
<style>
|
||||
/* CSS变量 */
|
||||
:root {
|
||||
--color-primary: #248aff;
|
||||
--color-success: #5cb85c;
|
||||
--color-info: #5bc0de;
|
||||
--color-danger: #d9534f;
|
||||
--color-warning: #f0ad4e;
|
||||
--color-text: #333;
|
||||
--color-text-muted: #777;
|
||||
--color-border: #ddd;
|
||||
--color-bg: #f5f5f5;
|
||||
--color-bg-panel: #fcfcfc;
|
||||
--navbar-height: 60px;
|
||||
--sidebar-width: 220px;
|
||||
}
|
||||
|
||||
/* 基础样式 */
|
||||
* { box-sizing: border-box; }
|
||||
body {
|
||||
margin: 0;
|
||||
padding-top: var(--navbar-height);
|
||||
font-family: "Roboto", "SF Pro SC", "SF Pro Display", "SF Pro Icons", "PingFang SC", BlinkMacSystemFont, -apple-system, "Segoe UI", "Microsoft Yahei", "Ubuntu", "Cantarell", "Fira Sans", "Droid Sans", "Helvetica Neue", "Helvetica", "Arial", sans-serif;
|
||||
font-size: 14px;
|
||||
line-height: 1.5;
|
||||
color: var(--color-text);
|
||||
-webkit-font-smoothing: antialiased;
|
||||
-moz-osx-font-smoothing: grayscale;
|
||||
}
|
||||
|
||||
/* 导航栏 */
|
||||
.navbar {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
height: var(--navbar-height);
|
||||
background: #f8f8f8;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
z-index: 1000;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
padding: 0 15px;
|
||||
}
|
||||
.navbar-brand {
|
||||
font-size: 18px;
|
||||
color: var(--color-text);
|
||||
text-decoration: none;
|
||||
}
|
||||
.navbar-brand:hover { color: var(--color-primary); }
|
||||
.navbar-form {
|
||||
margin-left: auto;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 8px;
|
||||
flex-wrap: wrap;
|
||||
}
|
||||
.navbar-form label {
|
||||
font-size: 13px;
|
||||
color: var(--color-text-muted);
|
||||
}
|
||||
.navbar-form input {
|
||||
padding: 6px 12px;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
font-size: 13px;
|
||||
width: 150px;
|
||||
}
|
||||
.navbar-form input:focus {
|
||||
outline: none;
|
||||
border-color: var(--color-primary);
|
||||
}
|
||||
.navbar-form .btn-save {
|
||||
padding: 6px 12px;
|
||||
background: var(--color-success);
|
||||
color: #fff;
|
||||
border: none;
|
||||
border-radius: 4px;
|
||||
cursor: pointer;
|
||||
font-size: 13px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 4px;
|
||||
}
|
||||
.navbar-form .btn-save:hover { background: #4cae4c; }
|
||||
.icon-save {
|
||||
width: 14px;
|
||||
height: 14px;
|
||||
fill: currentColor;
|
||||
}
|
||||
|
||||
/* 主容器 */
|
||||
.main-container {
|
||||
padding: 15px;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* 侧边栏 */
|
||||
.sidebar {
|
||||
width: var(--sidebar-width);
|
||||
position: fixed;
|
||||
left: 15px;
|
||||
top: calc(var(--navbar-height) + 15px);
|
||||
bottom: 15px;
|
||||
overflow-y: auto;
|
||||
background: #fff;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
}
|
||||
.sidebar-group { border-bottom: 1px solid var(--color-border); }
|
||||
.sidebar-group:last-child { border-bottom: none; }
|
||||
.sidebar-header {
|
||||
padding: 12px 15px;
|
||||
background: var(--color-bg);
|
||||
cursor: pointer;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
font-weight: 500;
|
||||
}
|
||||
.sidebar-header:hover { background: #eee; }
|
||||
.sidebar-header.active { background: #e8e8e8; }
|
||||
.sidebar-caret {
|
||||
width: 10px;
|
||||
height: 10px;
|
||||
border-right: 2px solid var(--color-text-muted);
|
||||
border-bottom: 2px solid var(--color-text-muted);
|
||||
transform: rotate(-45deg);
|
||||
transition: transform 0.2s;
|
||||
}
|
||||
.sidebar-header.expanded .sidebar-caret { transform: rotate(45deg); }
|
||||
.sidebar-items {
|
||||
display: none;
|
||||
padding: 0;
|
||||
}
|
||||
.sidebar-items.show { display: block; }
|
||||
.sidebar-item {
|
||||
padding: 10px 15px;
|
||||
cursor: pointer;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: space-between;
|
||||
}
|
||||
.sidebar-item:last-child { border-bottom: none; }
|
||||
.sidebar-item:hover { background: var(--color-bg); }
|
||||
.sidebar-item.active { background: #e0e0e0; }
|
||||
.sidebar-item .labels { display: flex; gap: 4px; }
|
||||
.sidebar-item .label {
|
||||
font-size: 12px;
|
||||
padding: 2px 6px;
|
||||
border-radius: 3px;
|
||||
color: #fff;
|
||||
}
|
||||
|
||||
/* API列表区域 */
|
||||
.api-list {
|
||||
margin-left: calc(var(--sidebar-width) + 30px);
|
||||
}
|
||||
.api-group-title {
|
||||
font-size: 1.2em;
|
||||
margin: 0 0 10px 0;
|
||||
padding-bottom: 5px;
|
||||
}
|
||||
.api-group-title:not(:first-child) {
|
||||
margin-top: 20px;
|
||||
border-top: 1px solid var(--color-border);
|
||||
padding-top: 15px;
|
||||
}
|
||||
|
||||
/* API面板 */
|
||||
.api-panel {
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
margin-bottom: 15px;
|
||||
background: #fff;
|
||||
}
|
||||
.api-header {
|
||||
padding: 12px 15px;
|
||||
background: var(--color-bg);
|
||||
cursor: pointer;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 10px;
|
||||
border-bottom: 1px solid transparent;
|
||||
}
|
||||
.api-header:hover { background: #eee; }
|
||||
.api-header.expanded { border-bottom-color: var(--color-border); }
|
||||
.api-header .label {
|
||||
font-size: 12px;
|
||||
padding: 3px 8px;
|
||||
border-radius: 3px;
|
||||
color: #fff;
|
||||
font-weight: normal;
|
||||
}
|
||||
.api-header .label-get { background: var(--color-info); }
|
||||
.api-header .label-post { background: var(--color-success); }
|
||||
.api-header .label-put { background: var(--color-warning); }
|
||||
.api-header .label-delete { background: var(--color-danger); }
|
||||
.api-header .label-patch { background: var(--color-primary); }
|
||||
.api-header .api-title { font-weight: normal; font-size: 14px; }
|
||||
.api-header .api-route { color: var(--color-text-muted); font-size: 12px; font-family: Verdana, sans-serif; }
|
||||
.api-body { display: none; padding: 15px; }
|
||||
.api-body.show { display: block; }
|
||||
|
||||
/* 标签页 */
|
||||
.tabs {
|
||||
display: flex;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
.tab-item {
|
||||
padding: 10px 15px;
|
||||
cursor: pointer;
|
||||
border-bottom: 2px solid transparent;
|
||||
margin-bottom: -1px;
|
||||
}
|
||||
.tab-item:hover { color: var(--color-primary); }
|
||||
.tab-item.active {
|
||||
color: var(--color-primary);
|
||||
border-bottom-color: var(--color-primary);
|
||||
}
|
||||
.tab-content { display: none; }
|
||||
.tab-content.active { display: block; }
|
||||
|
||||
/* 信息面板 */
|
||||
.info-panel {
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
.info-panel-header {
|
||||
padding: 10px 15px;
|
||||
background: var(--color-bg);
|
||||
font-weight: 600;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
}
|
||||
.info-panel-body { padding: 15px; }
|
||||
.info-panel-body .table { margin-bottom: 0; }
|
||||
|
||||
/* 概要说明 */
|
||||
.api-summary {
|
||||
background: var(--color-bg);
|
||||
padding: 15px;
|
||||
border-radius: 4px;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
/* 表格 */
|
||||
.table {
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
.table th, .table td {
|
||||
padding: 8px 12px;
|
||||
border-bottom: 1px solid var(--color-border);
|
||||
text-align: left;
|
||||
}
|
||||
.table th { background: var(--color-bg); font-weight: 600; }
|
||||
.table tbody tr:hover { background: #f9f9f9; }
|
||||
.table tbody tr:last-child td { border-bottom: none; }
|
||||
|
||||
/* 表单 */
|
||||
.form-group { margin-bottom: 15px; }
|
||||
.form-label {
|
||||
display: block;
|
||||
margin-bottom: 5px;
|
||||
font-weight: 500;
|
||||
}
|
||||
.form-input {
|
||||
width: 100%;
|
||||
padding: 8px 12px;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
font-size: 13px;
|
||||
}
|
||||
.form-input:focus {
|
||||
outline: none;
|
||||
border-color: var(--color-primary);
|
||||
}
|
||||
.form-submit { display: flex; gap: 10px; margin-top: 20px; }
|
||||
|
||||
/* 按钮 */
|
||||
.btn {
|
||||
padding: 8px 16px;
|
||||
border: none;
|
||||
border-radius: 4px;
|
||||
cursor: pointer;
|
||||
font-size: 13px;
|
||||
}
|
||||
.btn-success { background: var(--color-success); color: #fff; }
|
||||
.btn-success:hover { background: #4cae4c; }
|
||||
.btn-info { background: var(--color-info); color: #fff; }
|
||||
.btn-info:hover { background: #46b8da; }
|
||||
.btn-danger { background: var(--color-danger); color: #fff; }
|
||||
.btn-danger:hover { background: #c9302c; }
|
||||
.btn-xs { padding: 4px 8px; font-size: 12px; }
|
||||
|
||||
/* 标签 */
|
||||
.label {
|
||||
display: inline-block;
|
||||
padding: 3px 8px;
|
||||
border-radius: 3px;
|
||||
font-size: 12px;
|
||||
font-weight: normal;
|
||||
color: #fff;
|
||||
}
|
||||
.label-primary { background: var(--color-primary); }
|
||||
.label-success { background: var(--color-success); }
|
||||
.label-danger { background: var(--color-danger); }
|
||||
.label-warning { background: var(--color-warning); }
|
||||
.label-info { background: var(--color-info); }
|
||||
|
||||
/* 附加参数行 */
|
||||
.append-row {
|
||||
display: flex;
|
||||
gap: 10px;
|
||||
align-items: center;
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
.append-row .form-input { flex: 1; }
|
||||
.append-row-label { font-weight: 500; margin-bottom: 5px; display: block; }
|
||||
.append-row-inputs { display: flex; gap: 10px; }
|
||||
.append-row-inputs .input-name { width: 120px; }
|
||||
.append-row-inputs .input-value { flex: 1; }
|
||||
|
||||
/* 响应区域 */
|
||||
.response-area {
|
||||
background: #f8f8f8;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
padding: 15px;
|
||||
overflow-x: auto;
|
||||
margin-top: 15px;
|
||||
}
|
||||
.response-area pre {
|
||||
margin: 0;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
font-family: Consolas, Monaco, 'Courier New', monospace;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
/* 示例输出 */
|
||||
.sample-output pre {
|
||||
background: #f8f8f8;
|
||||
border: 1px solid var(--color-border);
|
||||
border-radius: 4px;
|
||||
padding: 15px;
|
||||
overflow-x: auto;
|
||||
margin: 0;
|
||||
font-family: Consolas, Monaco, 'Courier New', monospace;
|
||||
font-size: 13px;
|
||||
white-space: pre-wrap;
|
||||
word-break: break-all;
|
||||
}
|
||||
|
||||
/* JSON语法高亮 */
|
||||
.string { color: green; }
|
||||
.number { color: darkorange; }
|
||||
.boolean { color: blue; }
|
||||
.null { color: magenta; }
|
||||
.key { color: red; }
|
||||
|
||||
/* 页脚 */
|
||||
.footer {
|
||||
margin-top: 30px;
|
||||
padding-top: 15px;
|
||||
border-top: 1px solid var(--color-border);
|
||||
font-size: 12px;
|
||||
color: var(--color-text-muted);
|
||||
display: flex;
|
||||
justify-content: flex-end;
|
||||
}
|
||||
|
||||
/* 响应式布局 */
|
||||
@media (min-width: 1260px) {
|
||||
.main-container {
|
||||
max-width:1260px;
|
||||
margin: 0 auto;
|
||||
}
|
||||
.sidebar {
|
||||
left:calc(100%/2 - 630px + 15px);
|
||||
}
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<!-- 导航栏 -->
|
||||
<header class="navbar">
|
||||
<a class="navbar-brand" href="./" target="_blank">{$config.title}</a>
|
||||
<form class="navbar-form">
|
||||
<label>Token:</label>
|
||||
<input type="text" id="token" placeholder="token" title="{$lang.Tokentips}">
|
||||
<label>Apiurl:</label>
|
||||
<input type="text" id="apiUrl" placeholder="https://api.example.com" value="{$config.apiurl}" title="{$lang.Apiurltips}">
|
||||
<button type="button" class="btn btn-save" id="save_data" title="{$lang.Savetips}">
|
||||
<svg class="icon-save" viewBox="0 0 24 24"><path d="M17 3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.1 0 2-.9 2-2V7l-4-4zm-5 16c-1.66 0-3-1.34-3-3s1.34-3 3-3 3 1.34 3 3-1.34 3-3 3zm3-10H5V5h10v4z"/></svg>
|
||||
</button>
|
||||
</form>
|
||||
</header>
|
||||
|
||||
<div class="main-container">
|
||||
<!-- 侧边栏 -->
|
||||
<nav class="sidebar" id="sidebar">
|
||||
{foreach name="docsList" id="docs"}
|
||||
<div class="sidebar-group">
|
||||
<div class="sidebar-header" data-group="{$key|md5|substr=0,8}">
|
||||
{$key}
|
||||
<span class="sidebar-caret"></span>
|
||||
</div>
|
||||
<div class="sidebar-items" id="group-{$key|md5|substr=0,8}">
|
||||
{foreach name="docs" id="api"}
|
||||
<div class="sidebar-item" data-id="{$api.id}">
|
||||
{$api.title}
|
||||
<span class="labels">
|
||||
{if $api.needRight}
|
||||
<span class="label label-danger">鉴</span>
|
||||
{/if}
|
||||
{if $api.needLogin}
|
||||
<span class="label label-success">登</span>
|
||||
{/if}
|
||||
</span>
|
||||
</div>
|
||||
{/foreach}
|
||||
</div>
|
||||
</div>
|
||||
{/foreach}
|
||||
</nav>
|
||||
|
||||
<!-- API列表 -->
|
||||
<div class="api-list" id="apiList">
|
||||
{foreach name="docsList" id="docs"}
|
||||
<h2 class="api-group-title">{$key}</h2>
|
||||
{foreach name="docs" id="api"}
|
||||
<section class="api-panel" id="panel-{$api.id}">
|
||||
<div class="api-header" id="heading-{$api.id}" data-id="{$api.id}">
|
||||
<span class="label label-{$api.method|strtolower}">{$api.method|strtoupper}</span>
|
||||
<span class="api-title">{$api.title}</span>
|
||||
<span class="api-route">{$api.route}</span>
|
||||
</div>
|
||||
<div class="api-body" id="body-{$api.id}">
|
||||
<!-- 标签页 -->
|
||||
<div class="tabs" data-tabs="{$api.id}">
|
||||
<div class="tab-item active" data-tab="info{$api.id}">{$lang.Info}</div>
|
||||
<div class="tab-item" data-tab="sandbox{$api.id}">{$lang.Sandbox}</div>
|
||||
<div class="tab-item" data-tab="sample{$api.id}">{$lang.Sampleoutput}</div>
|
||||
</div>
|
||||
|
||||
<!-- Info标签 -->
|
||||
<div class="tab-content active" id="info{$api.id}">
|
||||
<div class="api-summary">{$api.summary}</div>
|
||||
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.Authorization}</strong></div>
|
||||
<div class="info-panel-body">
|
||||
<table class="table">
|
||||
<tr><td>{$lang.NeedLogin}</td><td>{$api.needLogin?'是':'否'}</td></tr>
|
||||
<tr><td>{$lang.NeedRight}</td><td>{$api.needRight?'是':'否'}</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{if $api.headersList}
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.Headers}</strong></div>
|
||||
<div class="info-panel-body">
|
||||
<table class="table">
|
||||
<thead><tr><th>{$lang.Name}</th><th>{$lang.Type}</th><th>{$lang.Required}</th><th>{$lang.Description}</th></tr></thead>
|
||||
<tbody>
|
||||
{foreach name="api['headersList']" id="header"}
|
||||
<tr><td>{$header.name}</td><td>{$header.type}</td><td>{$header.required?'是':'否'}</td><td>{$header.description}</td></tr>
|
||||
{/foreach}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
{if $api.paramsList}
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.Parameters}</strong></div>
|
||||
<div class="info-panel-body">
|
||||
<table class="table">
|
||||
<thead><tr><th>{$lang.Name}</th><th>{$lang.Type}</th><th>{$lang.Required}</th><th>{$lang.Description}</th></tr></thead>
|
||||
<tbody>
|
||||
{foreach name="api['paramsList']" id="param"}
|
||||
<tr><td>{$param.name}</td><td>{$param.type}</td><td>{$param.required?'是':'否'}</td><td>{$param.description}</td></tr>
|
||||
{/foreach}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.Body}</strong></div>
|
||||
<div class="info-panel-body">{$api.body|default='无'}</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Sandbox标签 -->
|
||||
<div class="tab-content" id="sandbox{$api.id}">
|
||||
{if $api.headersList}
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.Headers}</strong></div>
|
||||
<div class="info-panel-body headers" data-api="{$api.id}">
|
||||
{foreach name="api['headersList']" id="param"}
|
||||
<div class="form-group">
|
||||
<label class="form-label">{$param.name}</label>
|
||||
<input type="{$param.inputtype|default='text'}" class="form-input" name="{$param.name}" placeholder="{$param.description} - 例: {$param.sample}" {if $param.required}required{/if}>
|
||||
</div>
|
||||
{/foreach}
|
||||
</div>
|
||||
</div>
|
||||
{/if}
|
||||
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header">
|
||||
<strong>{$lang.Parameters}</strong>
|
||||
<span style="float:right"><button type="button" class="btn btn-xs btn-info btn-append">追加</button></span>
|
||||
</div>
|
||||
<div class="info-panel-body">
|
||||
<form id="form{$api.id}" action="{$api.route}" method="{$api.method}">
|
||||
{if $api.paramsList}
|
||||
{foreach name="api['paramsList']" id="param"}
|
||||
<div class="form-group">
|
||||
<label class="form-label">{$param.name}</label>
|
||||
<input type="{$param.inputtype|default='text'}" class="form-input" name="{$param.name}" placeholder="{$param.description}{if $param.sample} - 例: {$param.sample}{/if}" {if $param.required}required{/if}>
|
||||
</div>
|
||||
{/foreach}
|
||||
{else}
|
||||
<div class="form-group">无</div>
|
||||
{/if}
|
||||
<div class="form-group form-group-submit">
|
||||
<button type="submit" class="btn btn-success send" rel="{$api.id}">{$lang.Send}</button>
|
||||
<button type="reset" class="btn btn-info" rel="{$api.id}">{$lang.Reset}</button>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.Response}</strong></div>
|
||||
<div class="info-panel-body">
|
||||
<div class="response-area">
|
||||
<pre id="response_headers{$api.id}"></pre>
|
||||
<pre id="response{$api.id}"></pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{if $api.returnParamsList}
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.ReturnParameters}</strong></div>
|
||||
<div class="info-panel-body">
|
||||
<table class="table">
|
||||
<thead><tr><th>{$lang.Name}</th><th>{$lang.Type}</th><th>{$lang.Description}</th></tr></thead>
|
||||
<tbody>
|
||||
{foreach name="api['returnParamsList']" id="param"}
|
||||
<tr><td>{$param.name}</td><td>{$param.type}</td><td>{$param.description}</td></tr>
|
||||
{/foreach}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
{else}
|
||||
<div class="info-panel">
|
||||
<div class="info-panel-header"><strong>{$lang.ReturnParameters}</strong></div>
|
||||
<div class="info-panel-body">无</div>
|
||||
</div>
|
||||
{/if}
|
||||
</div>
|
||||
|
||||
<!-- Sample标签 -->
|
||||
<div class="tab-content sample-output" id="sample{$api.id}">
|
||||
<pre id="sample_response{$api.id}">{$api.return|default='无'}</pre>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
{/foreach}
|
||||
{/foreach}
|
||||
</div>
|
||||
|
||||
<!-- 页脚 -->
|
||||
<footer class="footer">
|
||||
<a href="./" target="_blank">{$config.sitename}</a>
|
||||
</footer>
|
||||
</div>
|
||||
|
||||
<!-- 附加参数模板 -->
|
||||
<template id="appendTpl">
|
||||
<div class="append-row form-group">
|
||||
<label class="append-row-label">自定义</label>
|
||||
<div class="append-row-inputs">
|
||||
<input type="text" class="form-input input-name" placeholder="名称">
|
||||
<input type="text" class="form-input input-value" placeholder="值">
|
||||
<button type="button" class="btn btn-xs btn-danger btn-remove">删除</button>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
(function() {
|
||||
|
||||
if(location.pathname.split('/').pop().toLowerCase() === 'api.html') {
|
||||
document.documentElement.innerHTML = '不允许使用的文件名';
|
||||
return;
|
||||
}
|
||||
// ====================== 本地使用限制 ======================
|
||||
function checkLocalOnly() {
|
||||
const hostname = window.location.hostname;
|
||||
const protocol = window.location.protocol;
|
||||
|
||||
if (protocol !== 'file:') {
|
||||
document.documentElement.innerHTML = `
|
||||
<style>
|
||||
body {
|
||||
margin: 0;
|
||||
height: 100vh;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
background: #1a1a1a;
|
||||
font-family: system-ui;
|
||||
color: #ff4444;
|
||||
}
|
||||
</style>
|
||||
<div style="text-align:center">
|
||||
<h1>⚠️ 禁止使用</h1>
|
||||
<p>此文档仅允许在<strong>本地</strong>运行，请勿部署至生产环境</p>
|
||||
<p style="color:#888;font-size:14px">请直接双击文档访问</p>
|
||||
</div>
|
||||
`;
|
||||
|
||||
console.error('%c[禁止] 此脚本仅允许本地使用', 'color:red;font-size:16px');
|
||||
throw new Error('Local use only');
|
||||
}
|
||||
}
|
||||
|
||||
checkLocalOnly();
|
||||
// JSON语法高亮
|
||||
function syntaxHighlight(json) {
|
||||
if (typeof json !== 'string') {
|
||||
json = JSON.stringify(json, null, 2);
|
||||
}
|
||||
json = json.replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>');
|
||||
return json.replace(/("(\\u[a-zA-Z0-9]{4}|\\[^u]|[^\\"])*"(\s*:)?|\b(true|false|null)\b|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?)/g, function(match) {
|
||||
var cls = 'number';
|
||||
if (/^"/.test(match)) {
|
||||
if (/:$/.test(match)) {
|
||||
cls = 'key';
|
||||
} else {
|
||||
cls = 'string';
|
||||
}
|
||||
} else if (/true|false/.test(match)) {
|
||||
cls = 'boolean';
|
||||
} else if (/null/.test(match)) {
|
||||
cls = 'null';
|
||||
}
|
||||
return '<span class="' + cls + '">' + match + '</span>';
|
||||
});
|
||||
}
|
||||
|
||||
function prepareStr(str) {
|
||||
try {
|
||||
return syntaxHighlight(JSON.stringify(JSON.parse(str.replace(/'/g, '"')), null, 2));
|
||||
} catch (e) {
|
||||
return str;
|
||||
}
|
||||
}
|
||||
|
||||
// localStorage检测
|
||||
var storage = (function() {
|
||||
var uid = new Date();
|
||||
var storageObj;
|
||||
var result;
|
||||
try {
|
||||
(storageObj = window.localStorage).setItem(uid, uid);
|
||||
result = storageObj.getItem(uid) === uid.toString();
|
||||
storageObj.removeItem(uid);
|
||||
return result && storageObj;
|
||||
} catch (e) {
|
||||
return null;
|
||||
}
|
||||
})();
|
||||
|
||||
// 初始化
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
// 加载保存的数据
|
||||
if (storage) {
|
||||
var savedToken = storage.getItem('token');
|
||||
var savedApiUrl = storage.getItem('apiUrl');
|
||||
if (savedToken) document.getElementById('token').value = savedToken;
|
||||
if (savedApiUrl) document.getElementById('apiUrl').value = savedApiUrl;
|
||||
}
|
||||
|
||||
// 处理示例输出高亮
|
||||
document.querySelectorAll('pre[id^="sample_response"], pre[id^="sample_post_body"]').forEach(function(pre) {
|
||||
if (pre.textContent !== 'NA' && pre.textContent !== '无') {
|
||||
var str = prepareStr(pre.textContent);
|
||||
pre.innerHTML = str;
|
||||
}
|
||||
});
|
||||
|
||||
});
|
||||
|
||||
// 侧边栏折叠
|
||||
document.querySelectorAll('.sidebar-header').forEach(function(header) {
|
||||
header.addEventListener('click', function() {
|
||||
var groupId = this.dataset.group;
|
||||
var items = document.getElementById('group-' + groupId);
|
||||
var isExpanded = this.classList.contains('expanded');
|
||||
|
||||
this.classList.toggle('expanded');
|
||||
this.classList.toggle('active');
|
||||
items.classList.toggle('show');
|
||||
});
|
||||
});
|
||||
|
||||
// 侧边栏项点击
|
||||
document.querySelectorAll('.sidebar-item').forEach(function(item) {
|
||||
item.addEventListener('click', function() {
|
||||
var apiId = this.dataset.id;
|
||||
var panel = document.getElementById('panel-' + apiId);
|
||||
var header = document.getElementById('heading-' + apiId);
|
||||
var body = document.getElementById('body-' + apiId);
|
||||
|
||||
// 移除其他active状态
|
||||
document.querySelectorAll('.sidebar-item').forEach(function(i) {
|
||||
i.classList.remove('active');
|
||||
});
|
||||
this.classList.add('active');
|
||||
|
||||
// 展开面板
|
||||
if (!body.classList.contains('show')) {
|
||||
header.classList.add('expanded');
|
||||
body.classList.add('show');
|
||||
}
|
||||
|
||||
// 滚动到面板
|
||||
var scrollTop = header.offsetTop - 70;
|
||||
window.scrollTo({ top: scrollTop, behavior: 'smooth' });
|
||||
});
|
||||
});
|
||||
|
||||
// API面板折叠
|
||||
document.querySelectorAll('.api-header').forEach(function(header) {
|
||||
header.addEventListener('click', function() {
|
||||
var body = this.nextElementSibling;
|
||||
this.classList.toggle('expanded');
|
||||
body.classList.toggle('show');
|
||||
});
|
||||
});
|
||||
|
||||
// 标签页切换
|
||||
document.querySelectorAll('.tab-item').forEach(function(tab) {
|
||||
tab.addEventListener('click', function() {
|
||||
var tabId = this.dataset.tab;
|
||||
var tabsContainer = this.parentElement;
|
||||
var apiId = tabsContainer.dataset.tabs;
|
||||
|
||||
// 移除同组内其他active
|
||||
tabsContainer.querySelectorAll('.tab-item').forEach(function(t) {
|
||||
t.classList.remove('active');
|
||||
});
|
||||
this.classList.add('active');
|
||||
|
||||
// 切换内容
|
||||
document.querySelectorAll('[id^="info' + apiId + '"], [id^="sandbox' + apiId + '"], [id^="sample' + apiId + '"]').forEach(function(content) {
|
||||
if (content.id === tabId) {
|
||||
content.classList.add('active');
|
||||
} else {
|
||||
content.classList.remove('active');
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
// 保存按钮
|
||||
document.getElementById('save_data').addEventListener('click', function() {
|
||||
if (storage) {
|
||||
storage.setItem('token', document.getElementById('token').value);
|
||||
storage.setItem('apiUrl', document.getElementById('apiUrl').value);
|
||||
} else {
|
||||
alert('浏览器不支持localStorage');
|
||||
}
|
||||
});
|
||||
|
||||
// 追加参数
|
||||
document.querySelectorAll('.btn-append').forEach(function(btn) {
|
||||
btn.addEventListener('click', function(e) {
|
||||
e.preventDefault();
|
||||
var panel = this.closest('.info-panel');
|
||||
var submitGroup = panel.querySelector('.form-group-submit');
|
||||
var template = document.getElementById('appendTpl');
|
||||
var clone = template.content.cloneNode(true);
|
||||
submitGroup.parentElement.insertBefore(clone, submitGroup);
|
||||
});
|
||||
});
|
||||
|
||||
// 删除附加参数
|
||||
document.addEventListener('click', function(e) {
|
||||
if (e.target.classList.contains('btn-remove')) {
|
||||
e.preventDefault();
|
||||
e.target.closest('.append-row').remove();
|
||||
}
|
||||
});
|
||||
|
||||
// 自定义参数名称输入
|
||||
document.addEventListener('keyup', function(e) {
|
||||
if (e.target.classList.contains('input-name')) {
|
||||
var row = e.target.closest('.append-row');
|
||||
var valueInput = row.querySelector('.input-value');
|
||||
valueInput.name = e.target.value;
|
||||
}
|
||||
});
|
||||
|
||||
// 发送请求
|
||||
document.querySelectorAll('.send').forEach(function(btn) {
|
||||
btn.addEventListener('click', function(e) {
|
||||
e.preventDefault();
|
||||
var form = this.closest('form');
|
||||
var theId = this.getAttribute('rel');
|
||||
var url = form.getAttribute('action');
|
||||
var method = (form.getAttribute('method') || 'get').toLowerCase();
|
||||
|
||||
// 收集表单数据
|
||||
var formData = new FormData();
|
||||
form.querySelectorAll('input').forEach(function(input) {
|
||||
if (input.type.toLowerCase() === 'file') {
|
||||
if (input.files[0]) {
|
||||
formData.append(input.name, input.files[0]);
|
||||
method = 'post';
|
||||
}
|
||||
} else if (input.name) {
|
||||
formData.append(input.name, input.value);
|
||||
}
|
||||
});
|
||||
|
||||
// 处理路由参数
|
||||
var matchedParamsInRoute = url.match(/[^{]+(?=\})/g);
|
||||
if (matchedParamsInRoute) {
|
||||
var params = {};
|
||||
formData.forEach(function(v, k) { params[k] = v; });
|
||||
matchedParamsInRoute.forEach(function(key) {
|
||||
var value = params[key] || '';
|
||||
url = url.replace('{' + key + '}', value);
|
||||
formData.delete(key);
|
||||
});
|
||||
}
|
||||
|
||||
// 收集headers
|
||||
var headers = {};
|
||||
var token = document.getElementById('token').value;
|
||||
if (token.length > 0) {
|
||||
headers['token'] = token;
|
||||
}
|
||||
|
||||
var sandboxBody = document.getElementById('body-' + theId);
|
||||
sandboxBody.querySelectorAll('.headers input[name]').forEach(function(input) {
|
||||
if (input.value.length > 0) {
|
||||
headers[input.name] = input.value;
|
||||
}
|
||||
});
|
||||
|
||||
// 构建请求URL
|
||||
var apiUrl = document.getElementById('apiUrl').value;
|
||||
var fullUrl = apiUrl + url;
|
||||
|
||||
// 发送fetch请求
|
||||
var options = {
|
||||
method: method,
|
||||
headers: headers,
|
||||
credentials: 'include'
|
||||
};
|
||||
|
||||
if (method !== 'get') {
|
||||
options.body = formData;
|
||||
} else {
|
||||
// GET请求参数拼接到URL
|
||||
var paramsStr = [];
|
||||
formData.forEach(function(v, k) {
|
||||
paramsStr.push(k + '=' + encodeURIComponent(v));
|
||||
});
|
||||
if (paramsStr.length > 0) {
|
||||
fullUrl += '?' + paramsStr.join('&');
|
||||
}
|
||||
}
|
||||
|
||||
fetch(fullUrl, options).then(function(response) {
|
||||
var headersPre = document.getElementById('response_headers' + theId);
|
||||
headersPre.innerHTML = 'HTTP ' + response.status + ' ' + response.statusText + '<br><br>' +
|
||||
Array.from(response.headers.entries()).map(function(h) { return h[0] + ': ' + h[1]; }).join('<br>');
|
||||
return response.text();
|
||||
}).then(function(text) {
|
||||
var responsePre = document.getElementById('response' + theId);
|
||||
try {
|
||||
var json = JSON.parse(text);
|
||||
responsePre.innerHTML = syntaxHighlight(JSON.stringify(json, null, 2));
|
||||
} catch (e) {
|
||||
responsePre.textContent = text;
|
||||
}
|
||||
}).catch(function(err) {
|
||||
var responsePre = document.getElementById('response' + theId);
|
||||
responsePre.textContent = 'Error: ' + err.message;
|
||||
});
|
||||
});
|
||||
});
|
||||
})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
在新工单中引用
屏蔽一个用户