Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
yubinCloud
fairy-wiki
提交
9838b8f3
F
fairy-wiki
项目概览
yubinCloud
/
fairy-wiki
通知
4
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
F
fairy-wiki
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
前往新版Gitcode,体验更适合开发者的 AI 搜索 >>
提交
9838b8f3
编写于
4月 28, 2021
作者:
yubinCloud
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
完善了 DocController 的Swagger注释
上级
1a71c2ae
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
12 addition
and
11 deletion
+12
-11
src/main/java/io/github/yubincloud/fairywiki/controller/DocController.java
...github/yubincloud/fairywiki/controller/DocController.java
+12
-11
未找到文件。
src/main/java/io/github/yubincloud/fairywiki/controller/DocController.java
浏览文件 @
9838b8f3
...
@@ -8,12 +8,16 @@ import io.github.yubincloud.fairywiki.dto.resp.ErrorCode;
...
@@ -8,12 +8,16 @@ import io.github.yubincloud.fairywiki.dto.resp.ErrorCode;
import
io.github.yubincloud.fairywiki.dto.resp.PageRespDto
;
import
io.github.yubincloud.fairywiki.dto.resp.PageRespDto
;
import
io.github.yubincloud.fairywiki.dto.resp.RestfulModel
;
import
io.github.yubincloud.fairywiki.dto.resp.RestfulModel
;
import
io.github.yubincloud.fairywiki.service.DocService
;
import
io.github.yubincloud.fairywiki.service.DocService
;
import
io.swagger.annotations.Api
;
import
io.swagger.annotations.ApiOperation
;
import
io.swagger.annotations.ApiParam
;
import
org.springframework.web.bind.annotation.*
;
import
org.springframework.web.bind.annotation.*
;
import
javax.annotation.Resource
;
import
javax.annotation.Resource
;
import
javax.validation.Valid
;
import
javax.validation.Valid
;
import
java.util.List
;
import
java.util.List
;
@Api
(
"文档管理"
)
@RestController
@RestController
@RequestMapping
(
"/doc"
)
@RequestMapping
(
"/doc"
)
public
class
DocController
{
public
class
DocController
{
...
@@ -21,10 +25,9 @@ public class DocController {
...
@@ -21,10 +25,9 @@ public class DocController {
@Resource
@Resource
private
DocService
docService
;
private
DocService
docService
;
/**
* 获取全部 Doc 的接口
*/
@GetMapping
(
"/query/{ebookId}"
)
@GetMapping
(
"/query/{ebookId}"
)
@ApiOperation
(
value
=
"获取属于某个 ebook 的全部 doc "
)
public
RestfulModel
<
List
<
DocQueryRespDto
>>
queryDocs
(
@PathVariable
Long
ebookId
)
{
public
RestfulModel
<
List
<
DocQueryRespDto
>>
queryDocs
(
@PathVariable
Long
ebookId
)
{
List
<
DocQueryRespDto
>
docList
=
docService
.
queryDocs
(
ebookId
);
List
<
DocQueryRespDto
>
docList
=
docService
.
queryDocs
(
ebookId
);
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
docList
);
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
docList
);
...
@@ -41,27 +44,25 @@ public class DocController {
...
@@ -41,27 +44,25 @@ public class DocController {
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
bookList
);
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
bookList
);
}
}
/**
* 根据请求的参数保存一个 doc,若id非空则为更新,否则为新增
*/
@PostMapping
(
"/save"
)
@PostMapping
(
"/save"
)
@ApiOperation
(
value
=
"保存一个 doc"
,
notes
=
"若id非空则为更新,否则为新增"
)
public
RestfulModel
<
Integer
>
saveDoc
(
@RequestBody
@Valid
DocSaveReqDto
docSaveReqDto
)
{
public
RestfulModel
<
Integer
>
saveDoc
(
@RequestBody
@Valid
DocSaveReqDto
docSaveReqDto
)
{
docService
.
save
(
docSaveReqDto
);
docService
.
save
(
docSaveReqDto
);
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
0
);
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
0
);
}
}
@DeleteMapping
(
"/delete"
)
@DeleteMapping
(
"/delete"
)
@ApiOperation
(
value
=
"删除一个 doc"
)
public
RestfulModel
<
Integer
>
deleteDoc
(
@RequestBody
@Valid
DocDeleteReqDto
docDeleteReqDto
)
{
public
RestfulModel
<
Integer
>
deleteDoc
(
@RequestBody
@Valid
DocDeleteReqDto
docDeleteReqDto
)
{
docService
.
deleteDocs
(
docDeleteReqDto
.
getIds
());
docService
.
deleteDocs
(
docDeleteReqDto
.
getIds
());
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
0
);
return
new
RestfulModel
<>(
ErrorCode
.
SUCCESS
,
""
,
0
);
}
}
/**
* 读取文档的内容
* @param docId 所要读取的文档的 id
* @return 读取到的内容
*/
@GetMapping
(
"/read-content/{docId}"
)
@GetMapping
(
"/read-content/{docId}"
)
@ApiOperation
(
value
=
"读取文档的内容"
,
notes
=
"同时会对该文档的阅读数 + 1"
)
@ApiParam
(
name
=
"docId"
,
value
=
"文档的id"
,
required
=
true
)
public
RestfulModel
<
String
>
readDocContent
(
@PathVariable
Long
docId
)
{
public
RestfulModel
<
String
>
readDocContent
(
@PathVariable
Long
docId
)
{
String
docContent
=
docService
.
readDocContent
(
docId
);
String
docContent
=
docService
.
readDocContent
(
docId
);
return
new
RestfulModel
<>(
0
,
""
,
docContent
);
return
new
RestfulModel
<>(
0
,
""
,
docContent
);
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录