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

这篇博客介绍了如何在mac与linux环境下安装apidoc,并通过apidoc工具为Python应用生成接口文档。详细步骤包括安装apidoc命令行工具,设置apidoc.json配置文件,以及在指定目录下生成HTML格式的接口文档。
摘要由CSDN通过智能技术生成

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": [{
               

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值