io.xiaper.restkefu.controller.v1

类 ArticleController

java.lang.Object

io.xiaper.rest.controller.v1.BaseController

io.xiaper.restkefu.controller.v1.ArticleController

@RestController
 @RequestMapping(value="/api/article")
public class ArticleController
extends io.xiaper.rest.controller.v1.BaseController

帮助中心Support: 文章

作者:

xiaper.io

字段概要

从类继承的字段 io.xiaper.rest.controller.v1.BaseController

logger

构造器概要

构造器

构造器和说明
ArticleController()

方法概要

限定符和类型	方法和说明
io.xiaper.jpa.util.JsonResult	create(Principal principal, Map map) 创建帮助文档
io.xiaper.jpa.util.JsonResult	delete(Principal principal, Map map) 删除帮助文档
io.xiaper.jpa.util.JsonResult	detail(Principal principal, String aid) 获取某帮助文档详情
io.xiaper.jpa.util.JsonResult	getArticles(Principal principal, Integer categoryId, int page, int size) 获取帮助文档 注： 如果 categoryId == 0，则返回 全部， categoryId == -1, 返回未分类 否则返回相关article
io.xiaper.jpa.util.JsonResult	getRecommends(Principal principal, String uid, String client) 获取推荐帮助文档： 右下角对话框：常见问题
io.xiaper.jpa.util.JsonResult	rate(Principal principal, Map map) 帮助文档：有帮助、无帮助 FIXME: 一个访客仅允许评价一次，不允许重复评价，但可以取消评价，或者改变评价
io.xiaper.jpa.util.JsonResult	update(Principal principal, Map map) 更新帮助文档

从类继承的方法 io.xiaper.rest.controller.v1.BaseController

getSpecification

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

ArticleController

public ArticleController()

方法详细资料

getArticles

@GetMapping(value="/get")
public io.xiaper.jpa.util.JsonResult getArticles(Principal principal,
                                                                           @RequestParam(value="categoryId")
                                                                           Integer categoryId,
                                                                           @RequestParam(value="page")
                                                                           int page,
                                                                           @RequestParam(value="size")
                                                                           int size)

获取帮助文档 注： 如果 categoryId == 0，则返回 全部， categoryId == -1, 返回未分类 否则返回相关article

参数:

principal - principal

categoryId - category

page - page

size - size

返回:

json

getRecommends

@GetMapping(value="/recommends")
public io.xiaper.jpa.util.JsonResult getRecommends(Principal principal,
                                                                                    @RequestParam(value="uid")
                                                                                    String uid,
                                                                                    @RequestParam(value="client")
                                                                                    String client)

获取推荐帮助文档： 右下角对话框：常见问题

参数:

principal - principal

uid - uid

client - client

返回:

json

create

@PostMapping(value="/create")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult create(Principal principal,
                                                                                         @RequestBody
                                                                                         Map map)

创建帮助文档

参数:

principal - principal

map - map

返回:

json

update

@PostMapping(value="/update")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult update(Principal principal,
                                                                                         @RequestBody
                                                                                         Map map)

更新帮助文档

参数:

principal - principal

map - map

返回:

json

delete

@PostMapping(value="/delete")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult delete(Principal principal,
                                                                                         @RequestBody
                                                                                         Map map)

删除帮助文档

参数:

principal - principal

map - map

返回:

json

detail

@GetMapping(value="/detail")
public io.xiaper.jpa.util.JsonResult detail(Principal principal,
                                                                         @RequestParam(value="aid")
                                                                         String aid)

获取某帮助文档详情

参数:

principal - principal

aid - aid

返回:

json

rate

@PostMapping(value="/rate")
 @ResponseBody
public io.xiaper.jpa.util.JsonResult rate(Principal principal,
                                                                                     @RequestBody
                                                                                     Map map)

帮助文档：有帮助、无帮助 FIXME: 一个访客仅允许评价一次，不允许重复评价，但可以取消评价，或者改变评价

参数:

principal - principal

map - map

返回:

json