使用Flask-Autodoc获取-pams文档

时间:2017-09-21 15:25:44

标签: python flask autodoc

我有一个api方法,需要2个GET参数。我可以使用Flask-Autodoc为这些参数生成文档,例如它适用于路径中的变量吗?

例如:

@auto.doc()
@app.route('/rss_filter')
def rssFilter():
    '''Filter rss-feed items by given words'''

    url = request.args.get('url')
    words = request.args.get('words').split(',')

    # Doing something ...

我希望看到这个函数的文档如下:

  

/ rss_filter
  方法:HEAD,GET,OPTIONS
  参数: url - Feed url, words - 以逗号分隔的单词列表
  描述:按给定的单词过滤rss-feed项目

0 个答案:

没有答案