apidoc 使用教程，说出自己爬过的坑

最新推荐文章于 2024-08-23 08:35:05 发布

秋天的铁工匠

最新推荐文章于 2024-08-23 08:35:05 发布

阅读量1.6k

点赞数 1

分类专栏： apidoc 文章标签： apidoc

本文链接：https://blog.csdn.net/weixin_37970049/article/details/100524148

版权

apidoc 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

apidoc使用爬坑教程 apidoc 是基于注释的

安装nodejs环境首先安装nodejs环境登录到 https://nodejs.org/en/download/ 下载nodejs安装环境我的是windows 下载傻瓜式安装即可

下载完成之后，无需任何花里胡哨的环境变量配置

下面跟着截图走就可以了

找到nodejs 文件夹
打开找到下面的 node,js command prompt
打开之后输入命令切换到你的项目下
最后在当前项目下执行这个命令 : apidoc -i ./ -o ./doc

在这里插入图片描述

解释一下这个命令 apidoc -i ./ 找到项目源文件的位置 -o ./doc 将文档输出到doc 里面去 ,没有doc会自动新建

这些命令其实都是apidoc官网有的地址 http://apidocjs.com/

然后我们打开项目下的doc
打开 index.html
双击出现下面的页面，我的有马赛克哈哈
第一句说是基于注释的，那注释怎么写呢，看下面

/**
     * @api {post} /biz/open/copartner/channel/operation/modifyUserInfo 门店管理更新用户信息
     * @apiName modifyUserInfo
     * @apiGroup user
     * @apiVersion 1.0.0
     * @apiPermission DARWIN_OPEN_UPDATE_USER
     * @apiDescription 门店管理更新用户信息.
     * @apiParam {String} userId 用户Id.
     * @apiParam {String} realName 用户名.
     * @apiParam {Integer} status 用户状态默认为0为可用，1为停用
     * @apiParam {Integer} roleType 角色类型.
     * @apiParam {Integer} roleType 角色类型.
     * @apiParam {Long} orgId 部门主键.
     * @apiParamExample {json} Request-Example:
     *     {
     *       "userId":1
     *       "realName": "xxxxxx",
     *       "status": 0,
     *       "roleType":1,
     *       "orgId":1
     *     }
     *
     * @apiSuccess {String} code 返回码
     * @apiSuccess {String} msg 描述信息
     *
     * @apiSuccessExample {json} Success-Response:
     * 	{
     * 		"code": "000000",
     * 		"msg": "SUCCESS"
     *  }
     *  @apiErrorExample Error-ResponseResult:
     *  {
     *  "code": "510002",
     *  "msg": "系统异常"
     *  }
     *
     *
     */
    @PutMapping(value="/channel/operation/modifyUserInfo")
    public YimiResult updateUser(@Valid @RequestBody ModifyChannelUserInfoRequest modifyChannelUserInfoRequest,BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            return  YimiResult.fail(ResultCodeConstant.PARAMS_INVALID,bindingResult.getFieldError().getDefaultMessage());
        }
        return  userService.modifyShopUserInfo(modifyChannelUserInfoRequest);
    }