Skip to content
GitLab
菜单
为什么选择 GitLab
定价
联系销售
探索
为什么选择 GitLab
定价
联系销售
探索
登录
获取免费试用
主导航
搜索或转到…
项目
GitLab
管理
动态
成员
标记
计划
议题
议题看板
里程碑
迭代
需求
代码
合并请求
仓库
分支
提交
标签
仓库图
比较修订版本
代码片段
锁定的文件
构建
流水线
作业
流水线计划
测试用例
产物
部署
发布
Package registry
Container registry
模型注册表
运维
环境
Terraform 模块
监控
事件
服务台
分析
价值流分析
贡献者分析
CI/CD 分析
仓库分析
代码评审分析
议题分析
洞察
模型实验
效能分析
帮助
帮助
支持
GitLab 文档
比较 GitLab 各版本
社区论坛
为极狐GitLab 提交贡献
提交反馈
隐私声明
快捷键
?
新增功能
4
代码片段
群组
项目
显示更多面包屑
gitlab-cn
GitLab
提交
f7f8d0a9
提交
f7f8d0a9
编辑于
5 years ago
作者:
Bob Van Landuyt
提交者:
Sean McGivern
5 years ago
浏览文件
操作
下载
补丁
差异文件
Document finding objects by id in GraphQL
We prefer not exposing a database ID directly.
上级
069c6420
No related branches found
分支 包含提交
No related tags found
标签 包含提交
无相关合并请求
变更
1
隐藏空白变更内容
行内
左右并排
显示
1 个更改的文件
doc/development/api_graphql_styleguide.md
+12
-5
12 个添加, 5 个删除
doc/development/api_graphql_styleguide.md
有
12 个添加
和
5 个删除
doc/development/api_graphql_styleguide.md
+
12
−
5
浏览文件 @
f7f8d0a9
...
...
@@ -43,14 +43,14 @@ a new presenter specifically for GraphQL.
The presenter is initialized using the object resolved by a field, and
the context.
### Exposing Global
id
s
### Exposing Global
ID
s
When exposing an
`
id
`
field on a type, we will by default try to
expose a global
id
by calling
`to_global_id`
on the resource being
When exposing an
`
ID
`
field on a type, we will by default try to
expose a global
ID
by calling
`to_global_id`
on the resource being
rendered.
To override this behaviour, you can implement an
`id`
method on the
type for which you are exposing an
id
. Please make sure that when
type for which you are exposing an
ID
. Please make sure that when
exposing a
`GraphQL::ID_TYPE`
using a custom method that it is
globally unique.
...
...
@@ -350,7 +350,10 @@ To find objects to display in a field, we can add resolvers to
`app/graphql/resolvers`
.
Arguments can be defined within the resolver, those arguments will be
made available to the fields using the resolver.
made available to the fields using the resolver. When exposing a model
that had an internal ID (
`iid`
), prefer using that in combination with
the namespace path as arguments in a resolver over a database
ID. Othewise use a
[
globally unique ID
](
#exposing-global-ids
)
.
We already have a
`FullPathLoader`
that can be included in other
resolvers to quickly find Projects and Namespaces which will have a
...
...
@@ -365,6 +368,10 @@ actions. In the same way a GET-request should not modify data, we
cannot modify data in a regular GraphQL-query. We can however in a
mutation.
To find objects for a mutation, arguments need to be specified. As with
[
resolvers
](
#resolvers
)
, prefer using internal ID or, if needed, a
global ID rather than the database ID.
### Fields
In the most common situations, a mutation would return 2 fields:
...
...
此差异已折叠。
点击以展开。
预览
0%
加载中
请重试
或
添加新附件
.
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
保存评论
取消
想要评论请
注册
或
登录