@apiIgnore 跳过在写的部份（未完成）

@apiSuccess 返回 Response 参数解释

  • 嵌套 json 解释

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

    def crop_image():
    """
    @api {post} /crop_image             Request to crop image for a pdf
    @apiName                            CropImagePost
    @apiGroup                           Cropper
    @apiVersion                         0.1.0
    @apiSuccess {String} code           Status code.
    @apiSuccess {Object[]} data         Tasks' result list.

    @apiSuccess {Number} data.code         Status code of the Task.
    @apiSuccess {String} data.coordinates  Coordinate group of the Task.

    @apiSuccessExample {json} Success Response json:
    {
      "code": 2000,
      "data": [
        {
          "code": 2000,
          "coordinates": "1,166.6,539.87,16.5022,9.1575;1,166.6,539.87,16.5022,9.1575",
        }
      ],
    }

    """
    pass

一个函数 多个 method

  • 注意

    • 要分成多个 注释块

       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

      app.route(methods=['GET', 'POST'])
def crop_image():
    """
    @api {get}  This is get method route
    @apiSuccess ...
    """
    """
    @api {post} This is post method route
    @apiSuccess ...
    """
    pass

request 参数问题

参数预定义

flask-apidoc

  • 提供 doc 服务

    1
2
3
4
5
6

    from flask_apidoc import ApiDoc

app = Flask(__name__)
doc = ApiDoc(app)

app.run()
    • 这样就能 展示 放置到 /static/docs 目录下 apidocjs 结果

  • 使用 flask 生成 apidoc

    1
2
3
4
5
6
7

    from flask_apidoc.commands import GenerateApiDoc
from flask_script import Manager

manager = Manager(app)
manager.add_command('apidoc', GenerateApiDoc())

manager.run()

    • 使用方法

      1
2
3
4
5

      python our_server.py                 # 生成帮助

python our_server.py apidoc          # 制作apidoc 文档

python ourt_server.py runserver      # 运行 rest_api service

    • 注意

      • 依赖 apidoc 命令

        1

        npm install -g apidoc