图身份

此技术笔记的目的是演示用于识别试图使用图的参与者的查询/更新。

此技术笔记的目的是演示查询/更新更新以识别试图使用图的参与者。以下示例可以启发如何在一个GraphQL模式中描述参与者身份，并包含用户和服务器的多个用例。

我们的用例识别了经过身份验证的用户和服务以及匿名用户。

首先，我们为查询和更新身份类型定义接口。

1
interface Identity {
2
  "An ID we can use to identify the session."
3
  id: ID!
4
}
5

6
interface MutableIdentity {
7
  "An ID we can use to identify the session."
8
  id: ID!
9
}

然后我们为我们认证和不认证的标识创建接口的具体类型。

1
type AnonymousIdentity implements Identity @key(fields: "id") {
2
  "An ID we can use to identify the session."
3
  id: ID!
4
}
5

6
type UserIdentity implements Identity @key(fields: "id") {
7
  "An ID we can use to identify the session."
8
  id: ID!
9
  "A reference to the authenticated user entity."
10
  user: User
11
}
12

13
type ServiceIdentity implements Identity @key(fields: "id") {
14
  "An ID we can use to identify the session."
15
  id: ID!
16
  "A reference to the authenticated service entity."
17
  service: Service
18
}

以及一个认证错误响应。

1
type NotAuthenticatedError {
2
  message: String
3
}

接下来，我们将构造我们的查询类型和响应联合体。在此我们选择了联合体，以便我们能够返回身份和错误作为响应数据。

可空性变得非常重要；可空性如何影响客户端处理失败的方式存在细微差别。

1
union AuthIdentity = UserIdentity | ServiceIdentity | NotAuthenticatedError
2
union CurrentUser = UserIdentity | AnonymousIdentity
3

4
type Query {
5
  "A query which returns an authenticated user or service, or an anonymous identity."
6
  session: Identity!
7
  "A query which returns the currently authenticated identity or an error."
8
  whoami: AuthIdentity!
9
  "A query which returns the currently authenticated user identity, or an anonymous identity."
10
  me: CurrentUser!
11
}

⚠️ 小心

在前面的示例中，所有的查询响应类型都不是可空的，这意味着如果服务器无法提供某种身份，则请求将失败。或者，我们也可以允许可空的响应，这些响应可以用来表示匿名或不认证的使用案例。

此外，通过在响应联合体中提供NotAuthenticatedError，我们可以在客户端应用程序中通知何时为用户提供特定体验。

然后通过分离突变和查询身份，我们能够分离：

可以在身份上执行的操作。
可以查询的身份。

1
type MutableAnonymousIdentity implements MutableIdentity @key(fields: "id") {
2
  id: ID!
3
  authenticateWithEmailAndPassword(
4
    credentials: EmailAndPasswordCredentials!
5
  ): UserIdentity!
6
}
7

8
type MutableUserIdentity implements MutableIdentity @key(fields: "id") {
9
  id: ID!
10
  resetPassword(credentials: ResetPasswordCredentials!): UserIdentity!
11
}
12

13
type MutableServiceIdentity implements MutableIdentity @key(fields: "id") {
14
  id: ID!
15
  service: MutableService!
16
}
17

18
union MutableCurrentUser = MutableUserIdentity | NotAuthenticatedError
19

20
type Mutation {
21
  session: MutableIdentity!
22
  me: MutableCurrentUser!
23
}

最后，使用先前定义的模式执行操作将如下所示。

1
query CurrentAuth {
2
    session {
3
        id
4
    }
5
    whoami {
6
        id
7
    }
8
    me {
9
        id
10
    }
11
}
12

13
mutation Login($credentials: EmailAndPasswordCredentials!) {
14
    session {
15
        ... on MutableAnonymousIdentity {
16
            authenticateWithEmailAndPassword(credentials: $credentials) {
17
                user {
18
                    ...
19
                }
20
            }
21
        }
22
    }
23
}
24

25
mutation ResetPassword($credentials: ResetPasswordCredentials!) {
26
    me {
27
        ... on MutableUserIdentity {
28
            resetPassword(credentials: $credentials) {
29
                user {
30
                    ...
31
                }
32
            }
33
        }
34
    }
35
}

接下来

首页