Python中使用flask_restplus.fields库定义API字段的默认值

在Python中使用Flask-RESTPlus库定义API字段的默认值可以通过flask_restplus.fields库中的Default类实现。

Default类用于设置字段的默认值，该类有以下常用参数：

- default: 字段的默认值，可以是常量值或者可调用函数。

- description (可选): 字段的描述信息。

- example (可选): 字段的示例值。

以下是一个使用Flask-RESTPlus库定义API字段默认值的示例：

from flask import Flask
from flask_restplus import Api, Namespace, fields


app = Flask(__name__)
api = Api(app)


ns = Namespace('users', description='User operations')

# 创建一个姓名字段，带有默认值为'Unknown'的字段
name_field = fields.String(required=True, default='Unknown', description='User name')

# 创建一个年龄字段，带有默认值为25的字段
age_field = fields.Integer(default=25, description='User age')

# 在命名空间中使用字段
@ns.route('/')
class Users(Resource):
    @ns.doc('get_users')
    @api.marshal_with(api.model('User', {
        'name': name_field,
        'age': age_field
    }))
    def get(self):
        return {'name': 'John', 'age': 30}

api.add_namespace(ns)

if __name__ == '__main__':
    app.run(debug=True)

上面的示例定义了一个名为users的命名空间，其中包含一个用于获取用户信息的GET请求。

在命名空间中，我们创建了一个名为User的模型，该模型包含了一个name字段和一个age字段。

在创建name字段时我们使用了Default类来设置默认值为'Unknown'并提供了字段的描述信息。

在创建age字段时我们使用了Default类来设置默认值为25并提供了字段的描述信息。

在GET请求的处理函数中，我们返回了一个包含名为John和年龄为30的用户信息的字典，该字典会经过marshal_with装饰器处理后返回给客户端。

通过上述示例，我们可以在定义API字段时使用Default类来设置字段的默认值，以及提供字段的描述信息和示例值。