python - Sphinx Autoflask - 区分同一功能上 GET 和 POST 请求的文档字符串

Question

我有一个 Flask 应用程序，我正在通过 python-sphinx 构建文档。

我目前正在使用 sphinxcontrib.autohttp.flask 的 autoflask 扩展

我的问题是:如何准备文档字符串，将不同的信息正确应用到同一路由的 GET 版本和 POST 版本。

例如一个小函数:

@app.route('/add_event', methods=['GET', 'POST'])
def add_event():
    """
    ..http:get:: /add_event
        :return: Test
    ..http:post:: /add_event
        :return: Test2
    """
    if request.method == 'GET':
        # get some things
        person_id = request.args.get('id')
        return render_template('create_event.html', race_event_form=test_form)
    if request.method == 'POST':
        # post some things

        return redirect('/person_profile/id/{0}'.format(request.args.get('id')))

conf.py 中我当前的扩展

extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.ifconfig',
    'sphinx.ext.viewcode',
    'sphinx.ext.githubpages',
    'sphinxcontrib.httpdomain',
    'sphinxcontrib.autohttp.flask',
    'sphinxcontrib.autohttp.flaskqref'
]

sphinx 输出看起来像

是否有可能为 GET 纠正一件事而为 POST 纠正另一件事？我真的很想避免将每个函数拆分为两个单独的 get/post 函数。

此外，是否可以让 autoflask 输出所需参数通过 request.args 或 request.form 传递，例如 person_id 变量获取请求？

Answer 1

尝试从 Flask autodoc 中删除重载的 View 函数并单独定义请求，同时让您的 API 的其余部分自动生成。

这是一个例子...

在 conf.py 中(插件的顺序很重要):

extensions = [
    'sphinx.ext.autodoc',
    'sphinxcontrib.httpdomain',
    'sphinxcontrib.autohttp.flask',
]

在重组文本文件中:

API
===

.. autoflask:: path.to.your:app
  :undoc-static:
  :undoc-endpoints: your_view_method

.. http:get:: / your_view_endpoint

  Some docstring you wrote.

.. http:post:: / your_view_endpoint

  Another docstring you wrote.

关于您的第二个问题，您可以查看httpdomain here 的指令。 .