通过电子邮件查询端点用户

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]