python 利用apidoc生成接口文档操作

apidoc安装，适用于mac与linux

sudo npm install apidoc -g

 

 

 

 

# 用户注册路由
@app.route('/user_manager/user_register.do', methods=['GET', 'POST'])
# @login_required
def user_register():
    """
        @api {GET，POST}   /user_manager/user_register.do  获取客户数据路由
        @apiGroup user_manager
        @apiDescription 客户数据页展示路由
        @apiName user_register
        @apiParam  behavior 行为 behavior = 1 注册 behavior = 2 登录（设计注册和登录按钮）
        @apiParam  name 用户名字
        @apiParam  password  用户密码   # 帐号或者密码错误
        @apiSuccessExample {json} 成功返回：
            {
        "message": "",
        "code": 200,
        "data": {
            "records": [{
                "status":"1"          status = 1 表示注册成功，直接跳转登录成功界面  status = 2 登录成功跳转 status = 3 注册失败  status = 4 登录失败（帐号或密码错误）
            }],
        }
        }
    """
    return user_views.user_register(request.args)

需要在指定路径下面新建doc文件夹

/home/python/Desktop/DMP/dmp_admin   在路径下面输出文档：apidoc --input ./app/ --output './doc'

#必需配置的apidoc.json文件
{
"name":"DMP管理后台API接口文档",
"version":"1.0.0",
"title":"API文档",
"url":"127.0.0.1",                可选择指定url，这里为本地
"order": [
    "portraitbi_activate_user_month",
    "portraitbi_activate_user_week",
    "portraitbi_all_user_num",
    "operatingbi_set_custom_channel_setting",
    "operatingbi_list_custom_channel_budget",
    "operatingbi_list_custom_bi"
]
}

 

生成的接口文档为html类型，可利用浏览器进行打开

file:///home/python/Desktop/DMP/dmp_admin/doc/index.html