You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dsProject/dsRes/Doc/v1.0/com_dsideal_resource_Res_Co...

468 lines
19 KiB

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>ResourceController</title>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/css/bootstrap.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/font-awesome@4.7.0/css/font-awesome.min.css">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/google-code-prettify@1.0.5/bin/prettify.min.css">
<link rel="stylesheet" href="style.css">
</head>
<body onload="PR.prettyPrint()">
<nav class="navbar">
<div class="container-fluid">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">
dsRes
</a>
</div>
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<li><a href="https://github.com/YeDaxia/JApiDocs" target="_blank">GitHub</a></li>
<li class="dropdown">
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">v1.0<span class="caret"></span></a>
<ul class="dropdown-menu">
</ul>
</li>
</ul>
</div>
</div>
</nav>
<div class="book with-summary">
<div class="book-summary">
<div class="search-box form-group">
<input type="text" class="form-control" id="inputSearch" placeholder="搜索接口">
<span class="glyphicon glyphicon-search form-control-feedback" aria-hidden="true"></span>
</div>
<div id="accordion" class="catalog">
<div class="panel">
<div id="heading0" data-parent="#accordion" class="catalog-title" data-toggle="collapse"
aria-expanded="true" data-target="#collapse0" aria-controls="collapse0">
<i class="glyphicon glyphicon-align-justify"></i> ResourceController
</div>
<div id="collapse0" class="collapse in " aria-labelledby="heading0">
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#getSignature">
获取Minio的上传签名
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#getSignatureByMd5">
获取Minio的上传签名
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#addResourceBase">
增加
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#delResourceBaseById">
删除
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#updateResourceBaseById">
按ID修改
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#getResourceBaseById">
按ID查询
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#getResourceBaseList">
查询列表
</a>
<a class="catalog-item" href="com_dsideal_resource_Res_Controller_ResourceController.html#getThumbs">
获取所有的扩展名与缩略图的关系
</a>
</div>
</div>
</div> </div>
<div class="book-body">
<div class="body-inner">
<div class="book-header">
<div class="d-flex justify-content-between">
<a class="header-menu toggle-catalog" href="javascript:void(0)"><i
class="glyphicon glyphicon-align-justify"></i> 目录</a>
</div>
</div>
<div class="page-wrapper">
<div class="page-inner">
<div class="action-list">
<div class="action-item">
<h2 id="getSignature"><a href="#">获取Minio的上传签名 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/getSignature</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>extension</td>
<td>string</td>
<td></td>
<td>上传的扩展名</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getSignatureByMd5"><a href="#">获取Minio的上传签名 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/getSignatureByMd5</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>extension</td>
<td>string</td>
<td></td>
<td>上传的扩展名</td>
</tr>
<tr>
<td>file_md5</td>
<td>string</td>
<td></td>
<td>文件md5值</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="addResourceBase"><a href="#">增加 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/addResourceBase</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>resource_title</td>
<td>string</td>
<td></td>
<td>资源名称</td>
</tr>
<tr>
<td>resource_size_int</td>
<td>long</td>
<td></td>
<td>资源大小</td>
</tr>
<tr>
<td>extension</td>
<td>string</td>
<td></td>
<td>扩展名</td>
</tr>
<tr>
<td>file_id</td>
<td>string</td>
<td></td>
<td>对应文件的id号是一个guid</td>
</tr>
<tr>
<td>file_md5</td>
<td>string</td>
<td></td>
<td>文件的md5值</td>
</tr>
<tr>
<td>scheme_id</td>
<td>int</td>
<td></td>
<td>结构id</td>
</tr>
<tr>
<td>structure_id</td>
<td>int</td>
<td></td>
<td>结构id</td>
</tr>
<tr>
<td>stage_id</td>
<td>int</td>
<td></td>
<td>学段id</td>
</tr>
<tr>
<td>subject_id</td>
<td>int</td>
<td></td>
<td>科目id</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="delResourceBaseById"><a href="#">删除 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/delResourceBaseById</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>resource_id_int</td>
<td>int</td>
<td></td>
<td>主键</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="updateResourceBaseById"><a href="#">按ID修改 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/updateResourceBaseById</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>resource_id_int</td>
<td>int</td>
<td></td>
<td>主键</td>
</tr>
<tr>
<td>resource_title</td>
<td>string</td>
<td></td>
<td>资源名称</td>
</tr>
<tr>
<td>resource_size_int</td>
<td>long</td>
<td></td>
<td>资源大小</td>
</tr>
<tr>
<td>person_id</td>
<td>string</td>
<td></td>
<td>上传人员id</td>
</tr>
<tr>
<td>scheme_id</td>
<td>int</td>
<td></td>
<td>结构id</td>
</tr>
<tr>
<td>structure_id</td>
<td>int</td>
<td></td>
<td>结构id</td>
</tr>
<tr>
<td>stage_id</td>
<td>int</td>
<td></td>
<td>学段id</td>
</tr>
<tr>
<td>subject_id</td>
<td>int</td>
<td></td>
<td>科目id</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getResourceBaseById"><a href="#">按ID查询 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/getResourceBaseById</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>resource_id_int</td>
<td>int</td>
<td></td>
<td>主键</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getResourceBaseList"><a href="#">查询列表 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/getResourceBaseList</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>请求参数</strong> <span class="badge">application/x-www-form-urlencoded</span></p>
<table class="table table-bordered">
<tr>
<th>参数名</th>
<th>类型</th>
<th>必须</th>
<th>描述</th>
</tr>
<tr>
<td>stage_id</td>
<td>int</td>
<td></td>
<td>学段</td>
</tr>
<tr>
<td>scheme_id</td>
<td>int</td>
<td></td>
<td>版本</td>
</tr>
<tr>
<td>subject_id</td>
<td>int</td>
<td></td>
<td>学科</td>
</tr>
<tr>
<td>structure_id</td>
<td>int</td>
<td></td>
<td>结构ID</td>
</tr>
<tr>
<td>keyword</td>
<td>string</td>
<td></td>
<td>搜索关键词</td>
</tr>
<tr>
<td>pageNum</td>
<td>int</td>
<td></td>
<td>页码</td>
</tr>
<tr>
<td>pageSize</td>
<td>int</td>
<td></td>
<td>每页数量</td>
</tr>
</table>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
<div class="action-item">
<h2 id="getThumbs"><a href="#">获取所有的扩展名与缩略图的关系 </a></h2>
<p><strong>请求URL</strong></p>
<p>
<code>/res/getThumbs</code>
<span class="label label-default">GET</span>
<span class="label label-default">POST</span>
</p>
<p><strong>返回结果</strong></p>
<pre class="prettyprint lang-json">{}</pre>
</div>
<hr>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.slim.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/bootstrap@3.3.7/dist/js/bootstrap.min.js"></script>
<script src="https://cdn.jsdelivr.net/autocomplete.js/0/autocomplete.jquery.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/google-code-prettify@1.0.5/bin/prettify.min.js"></script>
<script>
var search_source_data = [
{name: 'ResourceController.获取Minio的上传签名', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#getSignature'},
{name: 'ResourceController.获取Minio的上传签名', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#getSignatureByMd5'},
{name: 'ResourceController.增加', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#addResourceBase'},
{name: 'ResourceController.删除', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#delResourceBaseById'},
{name: 'ResourceController.按ID修改', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#updateResourceBaseById'},
{name: 'ResourceController.按ID查询', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#getResourceBaseById'},
{name: 'ResourceController.查询列表', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#getResourceBaseList'},
{name: 'ResourceController.获取所有的扩展名与缩略图的关系', url: 'com_dsideal_resource_Res_Controller_ResourceController.html#getThumbs'},
];
$('.toggle-catalog').click(function () {
$('.book').toggleClass('with-summary');
});
$('#inputSearch').autocomplete({hint: false}, [
{
source: function (query, callback) {
var result = [];
for(var i = 0; i !== search_source_data.length; i++){
if(search_source_data[i].name.indexOf(query) !== -1){
result.push(search_source_data[i]);
}
}
callback(result);
},
displayKey: 'name',
templates: {
suggestion: function (suggestion) {
return suggestion.name;
}
}
}
]).on('autocomplete:selected', function (event, suggestion, dataset, context) {
self.location = suggestion.url;
});
</script>
</body>
</html>