浏览代码

移除默认的api文档

优化api文档生成文本框
Karson 2 年之前
父节点
当前提交
cd5fafde38
共有 3 个文件被更改,包括 9 次插入4863 次删除
  1. 6 0
      application/admin/command/Api/library/Builder.php
  2. 3 3
      application/admin/command/Api/template/index.html
  3. 0 4860
      public/api.html

+ 6 - 0
application/admin/command/Api/library/Builder.php

@@ -88,11 +88,17 @@ class Builder
             return [];
         }
 
+        $typeArr = [
+            'integer' => 'number',
+            'file' => 'file',
+        ];
         $paramslist = array();
         foreach ($docs['ApiParams'] as $params) {
+            $inputtype = $params['type'] && isset($typeArr[$params['type']]) ? $typeArr[$params['type']] : ($params['name'] == 'password' ? 'password' : 'text');
             $tr = array(
                 'name'        => $params['name'],
                 'type'        => $params['type'] ?? 'string',
+                'inputtype'   => $inputtype,
                 'sample'      => $params['sample'] ?? '',
                 'required'    => $params['required'] ?? true,
                 'description' => $params['description'] ?? '',

+ 3 - 3
application/admin/command/Api/template/index.html

@@ -137,7 +137,7 @@
                             Apiurl:
                         </div>
                         <div class="form-group">
-                            <input id="apiUrl" type="text" class="form-control input-sm" data-toggle="tooltip" title="{$lang.Apiurltips}" placeholder="https://api.mydomain.com" value="{$config.apiurl}" />
+                            <input id="apiUrl" type="text" class="form-control input-sm" data-toggle="tooltip" title="{$lang.Apiurltips}" placeholder="https://api.example.com" value="{$config.apiurl}" />
                         </div>
                         <div class="form-group">
                             <button type="button" class="btn btn-success btn-sm" data-toggle="tooltip" title="{$lang.Savetips}" id="save_data">
@@ -295,7 +295,7 @@
                                                         {foreach name="api['headersList']" id="param"}
                                                         <div class="form-group">
                                                             <label class="control-label" for="{$param.name}">{$param.name}</label>
-                                                            <input type="{$param.type}" class="form-control input-sm" id="{$param.name}" {if $param.required}required{/if} placeholder="{$param.description} - Ex: {$param.sample}" name="{$param.name}">
+                                                            <input type="{$param.inputtype|default='text'}" class="form-control input-sm" id="{$param.name}" {if $param.required}required{/if} placeholder="{$param.description} - Ex: {$param.sample}" name="{$param.name}">
                                                         </div>
                                                         {/foreach}
                                                     </div>
@@ -314,7 +314,7 @@
                                                         {foreach name="api['paramsList']" id="param"}
                                                         <div class="form-group">
                                                             <label class="control-label" for="{$param.name}">{$param.name}</label>
-                                                            <input type="{$param.type}" class="form-control input-sm" id="{$param.name}" {if $param.required}required{/if} placeholder="{$param.description}{if $param.sample} - 例: {$param.sample}{/if}" name="{$param.name}">
+                                                            <input type="{$param.inputtype|default='text'}" class="form-control input-sm" id="{$param.name}" {if $param.required}required{/if} placeholder="{$param.description}{if $param.sample} - 例: {$param.sample}{/if}" name="{$param.name}">
                                                         </div>
                                                         {/foreach}
                                                         {else /}

文件差异内容过多而无法显示
+ 0 - 4860
public/api.html