Trouble distinguishing flask-marshmallow problems from embedded hack about flask-restplus-server-example HOT 4 CLOSED

0. You might want to start with a DB model field, so you go to teams/models.py and add your field there.

1. Next, you have several options:
   a. if your DB field can validate everything you need, you just list this field name in the relevant schema (e.g. teams/schemas.py:BaseTeamSchema.Meta.fields).

   class BaseTeamSchema(ModelSchema):
       class Meta:
           fields = (
               Team.id.key,
               Team.title.key,
               Team.my_date.key,
           )
           ...

   b. if you have a custom Schema field (e.g. StringOrDateField), you just define it on the Schema class (e.g. teams/schemas.py:BaseTeamSchema):

   class BaseTeamSchema(ModelSchema):
       my_date = StringOrDateField()
       class Meta:
           fields = (
               Team.id.key,
               Team.title.key,
               'my_date',
           )
           ...

   Alternatively, if you only need to validate the field (meaning that you are not going to change the value, but only check if it is correct in the current context), you can define a validation method on the Schema:

   from marshmallow import validates, ValidationError
   class BaseTeamSchema(ModelSchema):
       ...
       @validates('my_date')
       def validate_my_date(self, value):
           if value != 'now':
               raise ValidationError("My Date must be 'now'.")

   Also, read about validates_schema.

from flask-restplus-server-example.

It would be great to hear from you again about your successes extending this example server!

from flask-restplus-server-example.

from flask-restplus-server-example.

There are no views in users. Views are only used in auth, and they are implemented that way because Flask-OAuthlib requires it to be implemented the pure-Flask way. Auth module still needs some improvements, but after the recent refactoring round, it is not as hacky as it used to be, and I believe it is good enough to serve the demo purposes.

Users module is still quite advanced, but it is a completely resources-driven module.

Teams module was created exactly to show how one would implement a nice and clean module, so it is good to start there.

I guess resources (the nouns in the api) are the routes.

Exactly!

api = Namespace('teams', description="Teams")  # pylint: disable=invalid-name


@api.route('/')
class Teams(Resource):
...

Notice the teams argument to the Namespace, that is the common prefix for all of the resources defined in that file using @api.route() decorator.

from flask-restplus-server-example.