Java 类io.swagger.annotations.ApiImplicitParams 实例源码

项目：JavaQuarkBBS 文件：PostsController.java

@ApiOperation("发帖接口")
@ApiImplicitParams({
        @ApiImplicitParam(name = "content", value = "帖子内容", dataType = "String"),
        @ApiImplicitParam(name = "title", value = "帖子标题", dataType = "String"),
        @ApiImplicitParam(name = "token", value = "用户令牌", dataType = "String"),
        @ApiImplicitParam(name = "labelId", value = "标签ID", dataType = "Integer")
})
@PostMapping
public QuarkResult CreatePosts(Posts posts, String token, Integer labelId) {
    QuarkResult result = restProcessor(() -> {

        if (token == null) return QuarkResult.warn("请先登录！");

        User userbytoken = userService.getUserByToken(token);
        if (userbytoken == null) return QuarkResult.warn("用户不存在,请先登录！");

        User user = userService.findOne(userbytoken.getId());
        if (user.getEnable() != 1) return QuarkResult.warn("用户处于封禁状态！");

        postsService.savePosts(posts, labelId, user);
        return QuarkResult.ok();
    });

    return result;
}

项目：hauth-java 文件：DomainController.java

/**
 * 查询某一个域的详细信息
 * 如果http请求的参数domain_id为空，则返回null
 */
@RequestMapping(value = "/details", method = RequestMethod.GET)
@ApiOperation(value = "查询域的详细信息", notes = "查询某一个指定域的详细定义信息，如果请求的参数为空，则返回用户自己所在域的详细信息")
@ApiImplicitParams({
        @ApiImplicitParam(required = true, name = "domain_id", value = "域编码")
})
public String getDomainDetails(HttpServletRequest request) {
    String domainId = request.getParameter("domain_id");
    if (domainId == null || domainId.isEmpty()) {
        logger.info("domain id is empty, return null");
        return null;
    }

    // 检查用户对域有没有读权限
    Boolean status = authService.domainAuth(request, domainId, "r").getStatus();
    if (status) {
        return Hret.error(403, "您没有被授权访问域【" + domainId + "】", null);
    }

    DomainEntity domainEntity = domainService.getDomainDetails(domainId);
    return new GsonBuilder().create().toJson(domainEntity);
}

项目：hauth-java 文件：DomainController.java

/**
 * 更新域信息
 */
@RequestMapping(method = RequestMethod.PUT)
@ResponseBody
@ApiOperation(value = "更新域定义信息", notes = "更新域的详细信息，如：域名称，域状态")
@ApiImplicitParams({
        @ApiImplicitParam(required = true, name = "domain_id", value = "域编码"),
        @ApiImplicitParam(required = true, name = "domain_desc", value = "域描述信息")
})
public String update(HttpServletResponse response, HttpServletRequest request) {
    DomainEntity domainEntity = parse(request);
    Boolean status = authService.domainAuth(request, domainEntity.getDomain_id(), "w").getStatus();
    if (!status) {
        response.setStatus(403);
        return Hret.error(403, "你没有权限编辑域 [ " + domainEntity.getDomain_desc() + " ]", domainEntity);
    }

    RetMsg retMsg = domainService.update(domainEntity);
    if (retMsg.checkCode()) {
        return Hret.success(retMsg);
    }

    response.setStatus(retMsg.getCode());
    return Hret.error(retMsg);

}

项目：JavaQuarkBBS 文件：PostsController.java

@ApiOperation("翻页查询帖子接口")
@ApiImplicitParams({
        @ApiImplicitParam(name = "search", value = "查询条件", dataType = "int"),
        @ApiImplicitParam(name = "type", value = "帖子类型[top : good : ]", dataType = "String"),
        @ApiImplicitParam(name = "pageNo", value = "页码[从1开始]", dataType = "int"),
        @ApiImplicitParam(name = "length", value = "返回结果数量[默认20]", dataType = "int")
})
@GetMapping()
public QuarkResult GetPosts(
        @RequestParam(required = false, defaultValue = "") String search,
        @RequestParam(required = false, defaultValue = "") String type,
        @RequestParam(required = false, defaultValue = "1") int pageNo,
        @RequestParam(required = false, defaultValue = "20") int length) {
    QuarkResult result = restProcessor(() -> {
        if (!type.equals("good") && !type.equals("top") && !type.equals(""))
            return QuarkResult.error("类型错误!");
        Page<Posts> page = postsService.getPostsByPage(type, search, pageNo - 1, length);
        return QuarkResult.ok(page.getContent(), page.getTotalElements(), page.getNumberOfElements());

    });

    return result;

}

项目：JavaQuarkBBS 文件：PostsController.java

@ApiOperation("翻页帖子详情与回复接口")
@ApiImplicitParams({
        @ApiImplicitParam(name = "postsid", value = "帖子的id", dataType = "int"),
        @ApiImplicitParam(name = "pageNo", value = "页码[从1开始]", dataType = "int"),
        @ApiImplicitParam(name = "length", value = "返回结果数量[默认20]", dataType = "int")
})
@GetMapping("/detail/{postsid}")
public QuarkResult GetPostsDetail(
        @PathVariable("postsid") Integer postsid,
        @RequestParam(required = false, defaultValue = "1") int pageNo,
        @RequestParam(required = false, defaultValue = "20") int length) {
    QuarkResult result = restProcessor(() -> {
        HashMap<String, Object> map = new HashMap<>();
        Posts posts = postsService.findOne(postsid);
        if (posts == null) return QuarkResult.error("帖子不存在");
        map.put("posts", posts);

        Page<Reply> page = replyService.getReplyByPage(postsid, pageNo - 1, length);
        map.put("replys", page.getContent());

        return QuarkResult.ok(map, page.getTotalElements(), page.getNumberOfElements());
    });
    return result;

}

项目：JavaQuarkBBS 文件：PostsController.java

@ApiOperation("根据labelId获取帖子接口")
@ApiImplicitParams({
        @ApiImplicitParam(name = "labelid", value = "标签的id", dataType = "int"),
        @ApiImplicitParam(name = "pageNo", value = "页码[从1开始]", dataType = "int"),
        @ApiImplicitParam(name = "length", value = "返回结果数量[默认20]", dataType = "int"),
})
@GetMapping("/label/{labelid}")
public QuarkResult GetPostsByLabel(
        @PathVariable("labelid") Integer labelid,
        @RequestParam(required = false, defaultValue = "1") int pageNo,
        @RequestParam(required = false, defaultValue = "20") int length) {

    QuarkResult result = restProcessor(() -> {
        Label label = labelService.findOne(labelid);
        if (label == null) return QuarkResult.error("标签不存在");
        Page<Posts> page = postsService.getPostsByLabel(label, pageNo - 1, length);
        return QuarkResult.ok(page.getContent(), page.getTotalElements(), page.getNumberOfElements());

    });

    return result;

}