showdoc自动生成接口文档

今日任务完成，来这摸鱼写写博客，哈哈哈 ~

本文主要讲解showdoc + runapi （类似于postman）这两个工具组合使用，生成接口文档的操作。

showdoc官网地址：https://www.showdoc.com.cn/

1. runapi下载地址：https://www.showdoc.com.cn/server/api/attachment/visitFile?sign=8f705cae34509c16b85ee23692643d80
2. 下载完成后在客户端进行新建项目——>新建接口（这里就不进行展示了）
3. 以下是核心步骤

3.1 接口代码

@ApiOperation(value = "分页查询文章列表")
    @GetMapping
    @ApiImplicitParams({
            @ApiImplicitParam(name = "title", value = "关键词", paramType = "query"),
            @ApiImplicitParam(name = "typeName", value = "选择的分类名称", paramType = "query"),
            @ApiImplicitParam(name = "startDay", value = "开始日期(yyyy-MM-dd)", paramType = "query"),
            @ApiImplicitParam(name = "endDay", value = "结束日期(yyyy-MM-dd)", paramType = "query"),
            @ApiImplicitParam(name = "size", value = "分页大小", paramType = "query"),
            @ApiImplicitParam(name = "current", value = "当前页面：从1开始", paramType = "query")})
    public Result<IPage<HyArticleDetailVo>> findByPage(String title, String typeName, String startDay, String endDay, Page<HyArticleDetailVo> page) {
        Date startTime = DateUtils.parse(startDay + " 00:00:00", "yyyy-MM-dd HH:mm:ss");
        Date endTime   = DateUtils.parse(endDay + " 23:59:59", "yyyy-MM-dd HH:mm:ss");
        IPage<HyArticleDetailVo> list = hyArticleDetailService.findByPage(title, typeName, startTime, endTime, page);
        return ResultUtil.data(list);
    }

3.2 runapi中的操作：

4. 在线访问：https://www.showdoc.com.cn/item/index
   
   大功告成！（PS：可以设置成功返回示例和失败返回示例的，由于偷懒就没写啦~）

下面是完整的示例贴图：