mirror of
https://github.com/201206030/novel-cloud.git
synced 2025-04-27 01:40:50 +00:00
384 lines
16 KiB
HTML
384 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
||
<!-- NewPage -->
|
||
<html lang="zh">
|
||
<head>
|
||
<!-- Generated by javadoc (1.8.0_181) on Sat May 30 11:03:35 CST 2020 -->
|
||
<title>BookApi</title>
|
||
<meta name="date" content="2020-05-30">
|
||
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
|
||
<script type="text/javascript" src="../../../../../script.js"></script>
|
||
</head>
|
||
<body>
|
||
<script type="text/javascript"><!--
|
||
try {
|
||
if (location.href.indexOf('is-external=true') == -1) {
|
||
parent.document.title="BookApi";
|
||
}
|
||
}
|
||
catch(err) {
|
||
}
|
||
//-->
|
||
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
|
||
var tabs = {65535:["t0","所有方法"],2:["t2","实例方法"],4:["t3","抽象方法"]};
|
||
var altColor = "altColor";
|
||
var rowColor = "rowColor";
|
||
var tableTab = "tableTab";
|
||
var activeTableTab = "activeTableTab";
|
||
</script>
|
||
<noscript>
|
||
<div>您的浏览器已禁用 JavaScript。</div>
|
||
</noscript>
|
||
<!-- ========= START OF TOP NAVBAR ======= -->
|
||
<div class="topNav"><a name="navbar.top">
|
||
<!-- -->
|
||
</a>
|
||
<div class="skipNav"><a href="#skip.navbar.top" title="跳过导航链接">跳过导航链接</a></div>
|
||
<a name="navbar.top.firstrow">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="navList" title="导航">
|
||
<li><a href="../../../../../overview-summary.html">概览</a></li>
|
||
<li><a href="package-summary.html">程序包</a></li>
|
||
<li class="navBarCell1Rev">类</li>
|
||
<li><a href="class-use/BookApi.html">使用</a></li>
|
||
<li><a href="package-tree.html">树</a></li>
|
||
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
|
||
<li><a href="../../../../../index-files/index-1.html">索引</a></li>
|
||
<li><a href="../../../../../help-doc.html">帮助</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="subNav">
|
||
<ul class="navList">
|
||
<li>上一个类</li>
|
||
<li>下一个类</li>
|
||
</ul>
|
||
<ul class="navList">
|
||
<li><a href="../../../../../index.html?com/java2nb/novel/book/api/BookApi.html" target="_top">框架</a></li>
|
||
<li><a href="BookApi.html" target="_top">无框架</a></li>
|
||
</ul>
|
||
<ul class="navList" id="allclasses_navbar_top">
|
||
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
|
||
</ul>
|
||
<div>
|
||
<script type="text/javascript"><!--
|
||
allClassesLink = document.getElementById("allclasses_navbar_top");
|
||
if(window==top) {
|
||
allClassesLink.style.display = "block";
|
||
}
|
||
else {
|
||
allClassesLink.style.display = "none";
|
||
}
|
||
//-->
|
||
</script>
|
||
</div>
|
||
<div>
|
||
<ul class="subNavList">
|
||
<li>概要: </li>
|
||
<li>嵌套 | </li>
|
||
<li>字段 | </li>
|
||
<li>构造器 | </li>
|
||
<li><a href="#method.summary">方法</a></li>
|
||
</ul>
|
||
<ul class="subNavList">
|
||
<li>详细资料: </li>
|
||
<li>字段 | </li>
|
||
<li>构造器 | </li>
|
||
<li><a href="#method.detail">方法</a></li>
|
||
</ul>
|
||
</div>
|
||
<a name="skip.navbar.top">
|
||
<!-- -->
|
||
</a></div>
|
||
<!-- ========= END OF TOP NAVBAR ========= -->
|
||
<!-- ======== START OF CLASS DATA ======== -->
|
||
<div class="header">
|
||
<div class="subTitle">com.java2nb.novel.book.api</div>
|
||
<h2 title="接口 BookApi" class="title">接口 BookApi</h2>
|
||
</div>
|
||
<div class="contentContainer">
|
||
<div class="description">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<dl>
|
||
<dt>所有已知子接口:</dt>
|
||
<dd><a href="../../../../../com/java2nb/novel/home/feign/BookFeignClient.html" title="com.java2nb.novel.home.feign中的接口">BookFeignClient</a>, <a href="../../../../../com/java2nb/novel/search/feign/BookFeignClient.html" title="com.java2nb.novel.search.feign中的接口">BookFeignClient</a>, <a href="../../../../../com/java2nb/novel/user/feign/BookFeignClient.html" title="com.java2nb.novel.user.feign中的接口">BookFeignClient</a></dd>
|
||
</dl>
|
||
<hr>
|
||
<br>
|
||
<pre>public interface <span class="typeNameLabel">BookApi</span></pre>
|
||
<div class="block">小说微服务API接口定义（内部）</div>
|
||
<dl>
|
||
<dt><span class="simpleTagLabel">从以下版本开始:</span></dt>
|
||
<dd>2020/5/28</dd>
|
||
<dt><span class="simpleTagLabel">版本:</span></dt>
|
||
<dd>1.0</dd>
|
||
<dt><span class="simpleTagLabel">作者:</span></dt>
|
||
<dd>xiongxiaoyang</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="summary">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- ========== METHOD SUMMARY =========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="method.summary">
|
||
<!-- -->
|
||
</a>
|
||
<h3>方法概要</h3>
|
||
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="方法概要表, 列表方法和解释">
|
||
<caption><span id="t0" class="activeTableTab"><span>所有方法</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">实例方法</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">抽象方法</a></span><span class="tabEnd"> </span></span></caption>
|
||
<tr>
|
||
<th class="colFirst" scope="col">限定符和类型</th>
|
||
<th class="colLast" scope="col">方法和说明</th>
|
||
</tr>
|
||
<tr id="i0" class="altColor">
|
||
<td class="colFirst"><code>void</code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/java2nb/novel/book/api/BookApi.html#addBookComment-java.lang.Long-com.java2nb.novel.book.entity.BookComment-">addBookComment</a></span>(java.lang.Long userId,
|
||
<a href="../../../../../com/java2nb/novel/book/entity/BookComment.html" title="com.java2nb.novel.book.entity中的类">BookComment</a> comment)</code>
|
||
<div class="block">新增评论</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i1" class="rowColor">
|
||
<td class="colFirst"><code>java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/java2nb/novel/book/api/BookApi.html#listRank-java.lang.Byte-java.lang.Integer-">listRank</a></span>(java.lang.Byte type,
|
||
java.lang.Integer limit)</code>
|
||
<div class="block">小说排行数据查询列表</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i2" class="altColor">
|
||
<td class="colFirst"><code>java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/BookComment.html" title="com.java2nb.novel.book.entity中的类">BookComment</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/java2nb/novel/book/api/BookApi.html#listUserCommentByPage-java.lang.Long-int-int-">listUserCommentByPage</a></span>(java.lang.Long userId,
|
||
int page,
|
||
int pageSize)</code>
|
||
<div class="block">分页查询用户评论</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i3" class="rowColor">
|
||
<td class="colFirst"><code><a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/java2nb/novel/book/api/BookApi.html#queryBookById-java.lang.Long-">queryBookById</a></span>(java.lang.Long id)</code>
|
||
<div class="block">根据小说ID查询书籍</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i4" class="altColor">
|
||
<td class="colFirst"><code>java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/java2nb/novel/book/api/BookApi.html#queryBookByIds-java.util.List-">queryBookByIds</a></span>(java.util.List<java.lang.Long> ids)</code>
|
||
<div class="block">根据小说ID集合查询书籍列表</div>
|
||
</td>
|
||
</tr>
|
||
<tr id="i5" class="rowColor">
|
||
<td class="colFirst"><code>java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a>></code></td>
|
||
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/java2nb/novel/book/api/BookApi.html#queryBookByMinUpdateTime-java.util.Date-int-">queryBookByMinUpdateTime</a></span>(java.util.Date minDate,
|
||
int limit)</code>
|
||
<div class="block">根据最小更新时间分页查询书籍列表</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="details">
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<!-- ============ METHOD DETAIL ========== -->
|
||
<ul class="blockList">
|
||
<li class="blockList"><a name="method.detail">
|
||
<!-- -->
|
||
</a>
|
||
<h3>方法详细资料</h3>
|
||
<a name="queryBookByMinUpdateTime-java.util.Date-int-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>queryBookByMinUpdateTime</h4>
|
||
<pre>@GetMapping(value="api/book/queryBookByMinUpdateTime")
|
||
java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a>> queryBookByMinUpdateTime(@RequestParam(value="minDate")
|
||
java.util.Date minDate,
|
||
@RequestParam(value="limit")
|
||
int limit)</pre>
|
||
<div class="block">根据最小更新时间分页查询书籍列表</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">参数:</span></dt>
|
||
<dd><code>minDate</code> - 最小时间，包括该时间</dd>
|
||
<dd><code>limit</code> - 查询数量</dd>
|
||
<dt><span class="returnLabel">返回:</span></dt>
|
||
<dd>书籍列表</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="queryBookByIds-java.util.List-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>queryBookByIds</h4>
|
||
<pre>@GetMapping(value="api/book/queryBookByIds")
|
||
java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a>> queryBookByIds(@RequestBody
|
||
java.util.List<java.lang.Long> ids)</pre>
|
||
<div class="block">根据小说ID集合查询书籍列表</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">参数:</span></dt>
|
||
<dd><code>ids</code> - 小说ID集合</dd>
|
||
<dt><span class="returnLabel">返回:</span></dt>
|
||
<dd>书籍列表</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="listRank-java.lang.Byte-java.lang.Integer-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>listRank</h4>
|
||
<pre>@GetMapping(value="api/book/listRank")
|
||
java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a>> listRank(@RequestParam(value="type")
|
||
java.lang.Byte type,
|
||
@RequestParam(value="limit")
|
||
java.lang.Integer limit)</pre>
|
||
<div class="block">小说排行数据查询列表</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">参数:</span></dt>
|
||
<dd><code>type</code> - 排行类型，1：更新排行，2：新书排行，3评论排行</dd>
|
||
<dd><code>limit</code> - 查询数量</dd>
|
||
<dt><span class="returnLabel">返回:</span></dt>
|
||
<dd>书籍列表</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="queryBookById-java.lang.Long-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>queryBookById</h4>
|
||
<pre>@GetMapping(value="api/book/queryBookById")
|
||
<a href="../../../../../com/java2nb/novel/book/entity/Book.html" title="com.java2nb.novel.book.entity中的类">Book</a> queryBookById(@RequestParam(value="id")
|
||
java.lang.Long id)</pre>
|
||
<div class="block">根据小说ID查询书籍</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">参数:</span></dt>
|
||
<dd><code>id</code> - 小说ID</dd>
|
||
<dt><span class="returnLabel">返回:</span></dt>
|
||
<dd>书籍对象</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="addBookComment-java.lang.Long-com.java2nb.novel.book.entity.BookComment-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockList">
|
||
<li class="blockList">
|
||
<h4>addBookComment</h4>
|
||
<pre>@PostMapping(value="api/book/addBookComment")
|
||
void addBookComment(@RequestParam(value="userId")
|
||
java.lang.Long userId,
|
||
@RequestParam(value="comment")
|
||
<a href="../../../../../com/java2nb/novel/book/entity/BookComment.html" title="com.java2nb.novel.book.entity中的类">BookComment</a> comment)</pre>
|
||
<div class="block">新增评论</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">参数:</span></dt>
|
||
<dd><code>userId</code> - 用户ID</dd>
|
||
<dd><code>comment</code> - 评论数据</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
<a name="listUserCommentByPage-java.lang.Long-int-int-">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="blockListLast">
|
||
<li class="blockList">
|
||
<h4>listUserCommentByPage</h4>
|
||
<pre>@GetMapping(value="api/book/listUserCommentByPage")
|
||
java.util.List<<a href="../../../../../com/java2nb/novel/book/entity/BookComment.html" title="com.java2nb.novel.book.entity中的类">BookComment</a>> listUserCommentByPage(@RequestParam(value="userId")
|
||
java.lang.Long userId,
|
||
@RequestParam(value="page")
|
||
int page,
|
||
@RequestParam(value="pageSize")
|
||
int pageSize)</pre>
|
||
<div class="block">分页查询用户评论</div>
|
||
<dl>
|
||
<dt><span class="paramLabel">参数:</span></dt>
|
||
<dd><code>userId</code> - 用户ID</dd>
|
||
<dd><code>page</code> - 查询页码</dd>
|
||
<dd><code>pageSize</code> - 分页大小</dd>
|
||
<dt><span class="returnLabel">返回:</span></dt>
|
||
<dd>评论数据</dd>
|
||
</dl>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<!-- ========= END OF CLASS DATA ========= -->
|
||
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
||
<div class="bottomNav"><a name="navbar.bottom">
|
||
<!-- -->
|
||
</a>
|
||
<div class="skipNav"><a href="#skip.navbar.bottom" title="跳过导航链接">跳过导航链接</a></div>
|
||
<a name="navbar.bottom.firstrow">
|
||
<!-- -->
|
||
</a>
|
||
<ul class="navList" title="导航">
|
||
<li><a href="../../../../../overview-summary.html">概览</a></li>
|
||
<li><a href="package-summary.html">程序包</a></li>
|
||
<li class="navBarCell1Rev">类</li>
|
||
<li><a href="class-use/BookApi.html">使用</a></li>
|
||
<li><a href="package-tree.html">树</a></li>
|
||
<li><a href="../../../../../deprecated-list.html">已过时</a></li>
|
||
<li><a href="../../../../../index-files/index-1.html">索引</a></li>
|
||
<li><a href="../../../../../help-doc.html">帮助</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="subNav">
|
||
<ul class="navList">
|
||
<li>上一个类</li>
|
||
<li>下一个类</li>
|
||
</ul>
|
||
<ul class="navList">
|
||
<li><a href="../../../../../index.html?com/java2nb/novel/book/api/BookApi.html" target="_top">框架</a></li>
|
||
<li><a href="BookApi.html" target="_top">无框架</a></li>
|
||
</ul>
|
||
<ul class="navList" id="allclasses_navbar_bottom">
|
||
<li><a href="../../../../../allclasses-noframe.html">所有类</a></li>
|
||
</ul>
|
||
<div>
|
||
<script type="text/javascript"><!--
|
||
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
||
if(window==top) {
|
||
allClassesLink.style.display = "block";
|
||
}
|
||
else {
|
||
allClassesLink.style.display = "none";
|
||
}
|
||
//-->
|
||
</script>
|
||
</div>
|
||
<div>
|
||
<ul class="subNavList">
|
||
<li>概要: </li>
|
||
<li>嵌套 | </li>
|
||
<li>字段 | </li>
|
||
<li>构造器 | </li>
|
||
<li><a href="#method.summary">方法</a></li>
|
||
</ul>
|
||
<ul class="subNavList">
|
||
<li>详细资料: </li>
|
||
<li>字段 | </li>
|
||
<li>构造器 | </li>
|
||
<li><a href="#method.detail">方法</a></li>
|
||
</ul>
|
||
</div>
|
||
<a name="skip.navbar.bottom">
|
||
<!-- -->
|
||
</a></div>
|
||
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
||
</body>
|
||
</html>
|