无法使用apiDocjs生成文档

时间:2016-01-08 09:01:08

标签: api parsing documentation comments api-doc

通过几个教程和文档, 包括主要文档here。在它之后,创建了两个文件:

1)example.js

malloc

2)testpython.py

var currentUser={
name='Mary'
};
/**
* @api {get} /user/ Request User information
* @apiName GetUser
* @apiGroup User
*/

function getUser(){
 return {code 200,data:currentUser};
}
function setName(name){
    if(name.length==0){
      return {code:404,message:'NameEmptyError'};
    }
currentUser.name=name;
return {code 204};
}

将它们保存在一个文件夹中,例如“my_project”。 在mac终端上,转到“my_project”的父目录。 跑过剧本:

"""
@api {get} /user/ Request User information
@apiName GetUser
@apiGroup User
"""
print "hello"

获取错误:

apidoc -i my_project/ -o apidoc/

这是基本的,但不知何故,没有取得成功。

1 个答案:

答案 0 :(得分:3)

从npm和pip3安装软件包时会发生这种情况。完全清除当前安装的apiDoc软件包。 要删除npm包,请转到终端并键入:

cd /usr/local/lib/node_modules

然后要卸载它,请输入:

sudo npm uninstall apidoc

这将删除npm-apidoc包。 要删除pip3包:

sudo pip3 uninstall apidoc 

要手动删除它们,请转到:

/usr/local/lib/pythonVERSION/dist-packages

现在进行全新安装:

sudo npm install apidoc -g

这应该这样做:)。