通过邮件查询端点用户

Question

我正在尝试制作一种方法，允许我通过用户电子邮件查询端点。有没有比我在下面做的更好的方法呢？一种可能只返回一条或零条记录。

    @User.query_method(query_fields=('email',),
                       path='get_by_mail',
                       name='user.get_by_email')
    def get_by_email(self, query):
        return query

Answer 1

我假设User 是一些继承自EndpointsModel 的自定义模型。如果没有，这将失败。换句话说，你做了这样的事情：

from google.appengine.ext import ndb
from endpoints_proto_datastore.ndb import EndpointsModel

class User(EndpointsModel):
    email = ndb.StringProperty()
    ...

解决此问题有两种主要方法，您可以使用email 作为实体的键，或者滚动您自己的查询并尝试获取两个实体以查看您的结果是否唯一且是否存在。

选项 1：使用 email 作为键

您可以使用simple get 代替完整的查询。

from google.appengine.ext import endpoints

@endpoints.api(...)
class SomeClass(...):

    @User.method(request_fields=('email',),
                 path='get_by_mail/{email}',
                 http_method='GET', name='user.get_by_email')
    def get_by_email(self, user):
        if not user.from_datastore:
            raise endpoints.NotFoundException('User not found.')
        return user

通过使用电子邮件作为每个实体的数据存储键，就像在 custom alias properties sample 中所做的那样。例如：

from endpoints_proto_datastore.ndb import EndpointsAliasProperty

class User(EndpointsModel):
    # remove email here, as it will be an alias property 
    ...

    def EmailSet(self, value):
        # Validate the value any way you like
        self.UpdateFromKey(ndb.Key(User, value))

    @EndpointsAliasProperty(setter=IdSet, required=True)
    def email(self):
        if self.key is not None: return self.key.string_id()

选项 2：滚动您自己的查询

    @User.method(request_fields=('email',),
                 path='get_by_mail/{email}',
                 http_method='GET', name='user.get_by_email')
    def get_by_email(self, user):
        query = User.query(User.email == user.email)
        # We fetch 2 to make sure we have
        matched_users = query.fetch(2)
        if len(matched_users == 0):
            raise endpoints.NotFoundException('User not found.')
        elif len(matched_users == 2):
            raise endpoints.BadRequestException('User not unique.')
        else:
            return matched_users[0]