烧瓶Swagger留档查询参数GET必填

Question

我在烧瓶项目中使用Swagger留档来记录endpoint和参数。

要定义endpoint的查询参数，请执行以下操作：

@api.doc(params={
    'name_query_parameter': 'Description'})

我想知道该参数是否可以在文档中显示为“必需的”，就像参数是路径的一部分时一样（home/name_query_parameter/某事/某事）。

查看文档，我只发现以下内容：

@api.expect()
@api.doc(body=the_defined_payload)

但这意味着信息要在身体上，我不能用GET请求来获取。另外，我希望它作为查询参数，而不是有效载荷的一部分。

这可能吗？

谢了。

Answer 1

最终的解决方案如下，感谢 Mikhail 对解析器的评论。不过，我不得不承认，文档对于烧瓶Rest加来说并不是最好的。

我使用 params 部分来确保字段与描述和用于自定义验证的解析器一起出现在文档中，并使该字段显示为必需字段，即使它作为参数位于 URL 中。

parser = reqparse.RequestParser()
parser.add_argument('superimportant', 
type=inputs.boolean, location='args', required=True)
parser.add_argument('something', type=custom_validation_parser, location='args')

class MySuperClassResource(Resource):
@api.doc(parser=categories_by_retailer_parser,
         params={"superimportant": "Description of this important field",
                 "something": "bla bla"
                 })
def get(self, blable):
    parser.parse_args()
    pass

custom_validation_parser只是一个允许自定义验证的方法，就像对空值一样。该方法的格式如下。（它必须返回您想要访问的值，如果存在.问题，请引发ValueError）。

def custom_validation_parser(value):
    if not value:
        raise ValueError("Must not be empty.")
    return value