1
0
mirror of https://gitee.com/bookshelfplus/bookshelfplus synced 2025-09-02 23:23:28 +08:00
Code Issues Projects Releases Wiki Activity GitHub Gitee

更新一波pom依赖版本,重新生成api文档文件,添加pagehelper分页依赖

This commit is contained in:
2022-03-15 14:24:52 +08:00
parent cbfc277c9c
commit 41ed62e123
5 changed files with 266 additions and 419 deletions

View File

@@ -6,15 +6,15 @@
<option name="name" value="Maven Central repository" />
<option name="url" value="https://repo1.maven.org/maven2" />
</remote-repository>
<remote-repository>
<option name="id" value="jboss.community" />
<option name="name" value="JBoss Community repository" />
<option name="url" value="https://repository.jboss.org/nexus/content/repositories/public/" />
</remote-repository>
<remote-repository>
<option name="id" value="central" />
<option name="name" value="Central Repository" />
<option name="url" value="https://maven.aliyun.com/repository/public" />
</remote-repository>
<remote-repository>
<option name="id" value="spring-releases" />
<option name="name" value="spring-releases" />
<option name="url" value="https://repo.spring.io/libs-release" />
</remote-repository>
</component>
</project>

View File

@@ -14,7 +14,6 @@ __版本__ : 1.0
=== URI scheme
[%hardbreaks]
__域名__ : localhost:8090
__基础路径__ : /api
=== 标签
@@ -37,7 +36,7 @@ Book Controller
[[_getusingget]]
==== 获取书籍信息
....
GET /book/get
GET /api/book/get
....
@@ -47,7 +46,7 @@ GET /book/get
===== 参数
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^2a,.^3a,.^9a,.^4a"]
|===
|类型|名称|说明|类型
|**Query**|**id** +
@@ -57,10 +56,10 @@ __必填__|id|integer (int32)
===== 响应
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|<<_bookvo,BookVO>>
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
|**404**|Not Found|无内容
@@ -69,23 +68,14 @@ __必填__|id|integer (int32)
===== 生成
* `*/*`
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/book/get
----
====== 请求 query
[source,json]
----
{
"id" : 0
}
/api/book/get?id=0
----
@@ -95,23 +85,8 @@ __必填__|id|integer (int32)
[source,json]
----
{
"author" : "string",
"bookName" : "string",
"category" : {
"description" : "string",
"id" : 0,
"isShow" : true,
"level" : 0,
"name" : "string",
"order" : 0,
"parentId" : 0
},
"copyright" : "string",
"description" : "string",
"id" : 0,
"language" : "string",
"publishingHouse" : "string",
"thumbnail" : "string"
"data" : "object",
"status" : "string"
}
----
@@ -121,23 +96,23 @@ __必填__|id|integer (int32)
Status Controller
[[_getsystemloadaverageusingget]]
==== 系统负载
[[_getusingget_1]]
==== 系统状态
....
GET /status/getSystemLoadAverage
GET /api/status/get
....
===== 说明
获取服务器当前系统负载。
获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。
===== 响应
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|object
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
|**404**|Not Found|无内容
@@ -146,14 +121,14 @@ GET /status/getSystemLoadAverage
===== 生成
* `*/*`
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/status/getSystemLoadAverage
/api/status/get
----
@@ -162,7 +137,10 @@ GET /status/getSystemLoadAverage
====== 响应 200
[source,json]
----
"object"
{
"data" : "object",
"status" : "string"
}
----
@@ -174,7 +152,7 @@ User Controller
[[_loginusingpost]]
==== 用户登录
....
POST /user/login
POST /api/user/login
....
@@ -184,22 +162,22 @@ POST /user/login
===== 参数
[options="header", cols=".^2,.^3,.^9,.^4"]
[options="header", cols=".^2a,.^3a,.^4a"]
|===
|类型|名称|说明|类型
|类型|名称|类型
|**FormData**|**encryptpwd** +
__必填__|encryptpwd|string
__可选__|string
|**FormData**|**username** +
__必填__|username|string
__可选__|string
|===
===== 响应
[options="header", cols=".^2,.^14,.^4"]
[options="header", cols=".^2a,.^14a,.^4a"]
|===
|HTTP代码|说明|类型
|**200**|OK|<<_uservo,UserVO>>
|**200**|OK|<<_commonreturntype,CommonReturnType>>
|**201**|Created|无内容
|**401**|Unauthorized|无内容
|**403**|Forbidden|无内容
@@ -214,14 +192,14 @@ __必填__|username|string
===== 生成
* `*/*`
* `\*/*`
===== HTTP请求示例
====== 请求 path
----
/user/login
/api/user/login
----
@@ -238,12 +216,8 @@ __必填__|username|string
[source,json]
----
{
"avatar" : "string",
"id" : 0,
"nickname" : "string",
"phone" : "string",
"userIdentity" : "string",
"username" : "string"
"data" : "object",
"status" : "string"
}
----
@@ -253,73 +227,15 @@ __必填__|username|string
[[_definitions]]
== 定义
[[_bookvo]]
=== BookVO
[[_commonreturntype]]
=== CommonReturnType
[options="header", cols=".^3,.^11,.^4"]
[options="header", cols=".^3a,.^11a,.^4a"]
|===
|名称|说明|类型
|**author** +
__可选__|**样例** : `"string"`|string
|**bookName** +
__可选__|**样例** : `"string"`|string
|**category** +
__可选__|**样例** : `"<<_categorymodel>>"`|<<_categorymodel,CategoryModel>>
|**copyright** +
__可选__|**样例** : `"string"`|string
|**description** +
__可选__|**样例** : `"string"`|string
|**id** +
__可选__|**样例** : `0`|integer (int32)
|**language** +
__可选__|**样例** : `"string"`|enum (SIMPLIFIED_CHINESE, ENGLISH, TRADITIONAL_CHINESE)
|**publishingHouse** +
__可选__|**样例** : `"string"`|string
|**thumbnail** +
__可选__|**样例** : `"string"`|string
|===
[[_categorymodel]]
=== CategoryModel
[options="header", cols=".^3,.^11,.^4"]
|===
|名称|说明|类型
|**description** +
__可选__|**样例** : `"string"`|string
|**id** +
__可选__|**样例** : `0`|integer (int32)
|**isShow** +
__可选__|**样例** : `true`|boolean
|**level** +
__可选__|**样例** : `0`|integer (int32)
|**name** +
__可选__|**样例** : `"string"`|string
|**order** +
__可选__|**样例** : `0`|integer (int32)
|**parentId** +
__可选__|**样例** : `0`|integer (int32)
|===
[[_uservo]]
=== UserVO
[options="header", cols=".^3,.^11,.^4"]
|===
|名称|说明|类型
|**avatar** +
__可选__|**样例** : `"string"`|string
|**id** +
__可选__|**样例** : `0`|integer (int32)
|**nickname** +
__可选__|**样例** : `"string"`|string
|**phone** +
__可选__|**样例** : `"string"`|string
|**userIdentity** +
__可选__|**样例** : `"string"`|string
|**username** +
|**data** +
__可选__|**样例** : `"object"`|object
|**status** +
__可选__|**样例** : `"string"`|string
|===

View File

@@ -538,9 +538,7 @@ table.CodeRay td.code>pre{padding:0}
</li>
<li><a href="#_definitions">3. 定义</a>
<ul class="sectlevel2">
<li><a href="#_bookvo">3.1. BookVO</a></li>
<li><a href="#_categorymodel">3.2. CategoryModel</a></li>
<li><a href="#_uservo">3.3. UserVO</a></li>
<li><a href="#_commonreturntype">3.1. CommonReturnType</a></li>
</ul>
</li>
</ul>
@@ -562,8 +560,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="sect2">
<h3 id="_uri_scheme">1.2. URI scheme</h3>
<div class="paragraph">
<p><em>域名</em> : localhost:8090<br>
<em>基础路径</em> : /api</p>
<p><em>域名</em> : localhost:8090</p>
</div>
</div>
<div class="sect2">
@@ -596,7 +593,7 @@ table.CodeRay td.code>pre{padding:0}
<h4 id="_getusingget">2.1.1. 获取书籍信息</h4>
<div class="literalblock">
<div class="content">
<pre>GET /book/get</pre>
<pre>GET /api/book/get</pre>
</div>
</div>
<div class="sect4">
@@ -624,11 +621,19 @@ table.CodeRay td.code>pre{padding:0}
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>Query</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
<em>必填</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">id</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>Query</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>id</strong><br>
<em>必填</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>id</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>integer (int32)</p>
</div></div></td>
</tr>
</tbody>
</table>
@@ -650,24 +655,48 @@ table.CodeRay td.code>pre{padding:0}
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_bookvo">BookVO</a></p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>200</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>OK</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><a href="#_commonreturntype">CommonReturnType</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>401</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Unauthorized</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>403</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Forbidden</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>404</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Not Found</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
</tbody>
</table>
@@ -677,7 +706,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="ulist">
<ul>
<li>
<p><code><strong>/</strong></code></p>
<p><code>*/*</code></p>
</li>
</ul>
</div>
@@ -688,17 +717,7 @@ table.CodeRay td.code>pre{padding:0}
<h6 id="_请求_path">请求 path</h6>
<div class="listingblock">
<div class="content">
<pre>/book/get</pre>
</div>
</div>
</div>
<div class="sect5">
<h6 id="_请求_query">请求 query</h6>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
<span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>
}</code></pre>
<pre>/api/book/get?id=0</pre>
</div>
</div>
</div>
@@ -710,23 +729,8 @@ table.CodeRay td.code>pre{padding:0}
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
<span class="key"><span class="delimiter">&quot;</span><span class="content">author</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">bookName</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">category</span><span class="delimiter">&quot;</span></span> : {
<span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">isShow</span><span class="delimiter">&quot;</span></span> : <span class="value">true</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">level</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">name</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">order</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">parentId</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>
},
<span class="key"><span class="delimiter">&quot;</span><span class="content">copyright</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">description</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">language</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">publishingHouse</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">thumbnail</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>
<span class="key"><span class="delimiter">&quot;</span><span class="content">data</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">object</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">status</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>
}</code></pre>
</div>
</div>
@@ -740,16 +744,16 @@ table.CodeRay td.code>pre{padding:0}
<p>Status Controller</p>
</div>
<div class="sect3">
<h4 id="_getsystemloadaverageusingget">2.2.1. 系统负载</h4>
<h4 id="_getusingget_1">2.2.1. 系统状态</h4>
<div class="literalblock">
<div class="content">
<pre>GET /status/getSystemLoadAverage</pre>
<pre>GET /api/status/get</pre>
</div>
</div>
<div class="sect4">
<h5 id="_说明_2">说明</h5>
<div class="paragraph">
<p>获取服务器当前系统负载。</p>
<p>获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。</p>
</div>
</div>
<div class="sect4">
@@ -769,24 +773,48 @@ table.CodeRay td.code>pre{padding:0}
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">object</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>200</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>OK</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><a href="#_commonreturntype">CommonReturnType</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>401</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Unauthorized</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>403</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Forbidden</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>404</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Not Found</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
</tbody>
</table>
@@ -796,7 +824,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="ulist">
<ul>
<li>
<p><code><strong>/</strong></code></p>
<p><code>*/*</code></p>
</li>
</ul>
</div>
@@ -807,7 +835,7 @@ table.CodeRay td.code>pre{padding:0}
<h6 id="_请求_path_2">请求 path</h6>
<div class="listingblock">
<div class="content">
<pre>/status/getSystemLoadAverage</pre>
<pre>/api/status/get</pre>
</div>
</div>
</div>
@@ -818,7 +846,10 @@ table.CodeRay td.code>pre{padding:0}
<h6 id="_响应_200_2">响应 200</h6>
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">&quot;</span><span class="content">object</span><span class="delimiter">&quot;</span></span></code></pre>
<pre class="CodeRay highlight"><code data-lang="json">{
<span class="key"><span class="delimiter">&quot;</span><span class="content">data</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">object</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">status</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>
}</code></pre>
</div>
</div>
</div>
@@ -834,7 +865,7 @@ table.CodeRay td.code>pre{padding:0}
<h4 id="_loginusingpost">2.3.1. 用户登录</h4>
<div class="literalblock">
<div class="content">
<pre>POST /user/login</pre>
<pre>POST /api/user/login</pre>
</div>
</div>
<div class="sect4">
@@ -847,33 +878,41 @@ table.CodeRay td.code>pre{padding:0}
<h5 id="_参数_2">参数</h5>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 11.1111%;">
<col style="width: 16.6666%;">
<col style="width: 50%;">
<col style="width: 22.2223%;">
<col style="width: 22.2222%;">
<col style="width: 33.3333%;">
<col style="width: 44.4445%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">类型</th>
<th class="tableblock halign-left valign-middle">名称</th>
<th class="tableblock halign-left valign-middle">说明</th>
<th class="tableblock halign-left valign-middle">类型</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>FormData</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>encryptpwd</strong><br>
<em>必填</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">encryptpwd</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>encryptpwd</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>string</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>FormData</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>username</strong><br>
<em>必填</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">username</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>FormData</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>username</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>string</p>
</div></div></td>
</tr>
</tbody>
</table>
@@ -895,29 +934,59 @@ table.CodeRay td.code>pre{padding:0}
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>200</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">OK</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_uservo">UserVO</a></p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>200</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>OK</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><a href="#_commonreturntype">CommonReturnType</a></p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>201</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Created</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>201</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Created</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>401</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Unauthorized</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>401</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Unauthorized</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>403</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Forbidden</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>403</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Forbidden</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>404</strong></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">Not Found</p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">无内容</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>404</strong></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>Not Found</p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>无内容</p>
</div></div></td>
</tr>
</tbody>
</table>
@@ -937,7 +1006,7 @@ table.CodeRay td.code>pre{padding:0}
<div class="ulist">
<ul>
<li>
<p><code><strong>/</strong></code></p>
<p><code>*/*</code></p>
</li>
</ul>
</div>
@@ -948,7 +1017,7 @@ table.CodeRay td.code>pre{padding:0}
<h6 id="_请求_path_3">请求 path</h6>
<div class="listingblock">
<div class="content">
<pre>/user/login</pre>
<pre>/api/user/login</pre>
</div>
</div>
</div>
@@ -968,12 +1037,8 @@ table.CodeRay td.code>pre{padding:0}
<div class="listingblock">
<div class="content">
<pre class="CodeRay highlight"><code data-lang="json">{
<span class="key"><span class="delimiter">&quot;</span><span class="content">avatar</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">id</span><span class="delimiter">&quot;</span></span> : <span class="integer">0</span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">nickname</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">phone</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">userIdentity</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">username</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>
<span class="key"><span class="delimiter">&quot;</span><span class="content">data</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">object</span><span class="delimiter">&quot;</span></span>,
<span class="key"><span class="delimiter">&quot;</span><span class="content">status</span><span class="delimiter">&quot;</span></span> : <span class="string"><span class="delimiter">&quot;</span><span class="content">string</span><span class="delimiter">&quot;</span></span>
}</code></pre>
</div>
</div>
@@ -987,7 +1052,7 @@ table.CodeRay td.code>pre{padding:0}
<h2 id="_definitions">3. 定义</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_bookvo">3.1. BookVO</h3>
<h3 id="_commonreturntype">3.1. CommonReturnType</h3>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 16.6666%;">
@@ -1003,174 +1068,28 @@ table.CodeRay td.code>pre{padding:0}
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>author</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>data</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>样例</strong> : <code>"object"</code></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>object</p>
</div></div></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>bookName</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>category</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"<a href="#_categorymodel">CategoryModel</a>"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><a href="#_categorymodel">CategoryModel</a></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>copyright</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>0</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>language</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">enum (SIMPLIFIED_CHINESE, ENGLISH, TRADITIONAL_CHINESE)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>publishingHouse</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>thumbnail</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_categorymodel">3.2. CategoryModel</h3>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 16.6666%;">
<col style="width: 61.1111%;">
<col style="width: 22.2223%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">名称</th>
<th class="tableblock halign-left valign-middle">说明</th>
<th class="tableblock halign-left valign-middle">类型</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>description</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>0</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>isShow</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>true</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">boolean</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>level</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>0</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>name</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>order</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>0</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>parentId</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>0</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect2">
<h3 id="_uservo">3.3. UserVO</h3>
<table class="tableblock frame-all grid-all spread">
<colgroup>
<col style="width: 16.6666%;">
<col style="width: 61.1111%;">
<col style="width: 22.2223%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-middle">名称</th>
<th class="tableblock halign-left valign-middle">说明</th>
<th class="tableblock halign-left valign-middle">类型</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>avatar</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>id</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>0</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">integer (int32)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>nickname</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>phone</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>userIdentity</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>username</strong><br>
<em>可选</em></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock"><strong>样例</strong> : <code>"string"</code></p></td>
<td class="tableblock halign-left valign-middle"><p class="tableblock">string</p></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>status</strong><br>
<em>可选</em></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p><strong>样例</strong> : <code>"string"</code></p>
</div></div></td>
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
<p>string</p>
</div></div></td>
</tr>
</tbody>
</table>
@@ -1180,7 +1099,7 @@ table.CodeRay td.code>pre{padding:0}
</div>
<div id="footer">
<div id="footer-text">
Last updated 2022-03-14 23:47:49 SGT
Last updated 2022-03-15 14:14:39 SGT
</div>
</div>
</body>

View File

@@ -15,7 +15,7 @@
<parent>
<artifactId>spring-boot-starter-parent</artifactId>
<groupId>org.springframework.boot</groupId>
<version>2.1.2.RELEASE</version>
<version>2.3.12.RELEASE</version>
</parent>
<properties>
@@ -41,7 +41,7 @@
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.13</version>
<version>4.13.2</version>
<scope>test</scope>
</dependency>
@@ -49,7 +49,7 @@
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>2.6.4</version>
<version>2.3.12.RELEASE</version>
</dependency>
<!--MySQL依赖-->
@@ -76,21 +76,21 @@
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.7</version>
<version>3.12.0</version>
</dependency>
<!--参数验证-->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.4.3.Final</version>
<version>7.0.3.Final</version>
</dependency>
<!--日期时间-->
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
<version>2.9.1</version>
<version>2.10.13</version>
</dependency>
<!--引入SpringBoot对Redis的依赖-->
@@ -107,7 +107,6 @@
</dependency> -->
<!-- lombok -->
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
@@ -128,21 +127,24 @@
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
<version>3.0.0</version>
</dependency>
<!--前面引入过这个包-->
<!--<dependency>-->
<!-- <groupId>org.springframework.boot</groupId>-->
<!-- <artifactId>spring-boot-starter-web</artifactId>-->
<!--</dependency>-->
<!-- 注意3.0.0 需要starter -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<version>2.6.4</version>
<scope>test</scope>
</dependency>
@@ -152,18 +154,24 @@
<dependency>
<groupId>io.github.swagger2markup</groupId>
<artifactId>swagger2markup</artifactId>
<version>1.3.1</version>
<version>1.3.3</version>
</dependency>
<dependency>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctorj-pdf</artifactId>
<version>1.5.0-alpha.10.1</version>
<version>1.6.2</version>
<scope>test</scope>
</dependency>
<!--
PageHelper 分页插件
-->
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.4.1</version>
</dependency>
</dependencies>
<build>

View File

@@ -12,6 +12,10 @@ public class BaseController {
// content-type 常量
public static final String CONTENT_TYPE_FORMED = "application/x-www-form-urlencoded";
// PageHelper分页常量
public static final Integer COMMON_START_PAGE = 1;
public static final Integer COMMON_PAGE_SIZE = 10;
@Autowired
HttpServletRequest httpServletRequest;