浏览了一些教程和文档, 包括主要文档here。随后创建了两个文件:
示例.js
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};
}
测试python.py
"""
@api {get} /user/ Request User information
@apiName GetUser
@apiGroup User
"""
print "hello"
将它们都保存在一个文件夹中,例如“my_project”。 在 Mac 终端上,转到“my_project”的父目录。 运行脚本:
apidoc -i my_project/ -o apidoc/
出现错误:
- 错误 - 无法解析源
这是基本的,但不知何故,没有取得成功。
当您从 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
这应该可以做到:)。