GraphQL API · Gitlab 中文文檔

# GraphQL API > 原文：[https://docs.gitlab.com/ee/api/graphql/](https://docs.gitlab.com/ee/api/graphql/) * [Getting Started](#getting-started) * [Quick Reference](#quick-reference) * [GraphiQL](#graphiql) * [What is GraphQL?](#what-is-graphql) * [Vision](#vision) * [Available queries](#available-queries) * [Multiplex queries](#multiplex-queries) * [Reference](#reference) # GraphQL API[](#graphql-api "Permalink") 版本歷史 * 在 GitLab 11.0 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19008) （由功能標志`graphql`啟用）. * [始終](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30444)在 GitLab 12.1 中[啟用](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30444) . ## Getting Started[](#getting-started "Permalink") 有關 GitLab GraphQL API 的新知識，請參見 GitLab GraphQL API [入門](getting_started.html) . ### Quick Reference[](#quick-reference "Permalink") * GitLab 的 GraphQL API 端點位于`/api/graphql` . * [從 graphql.org](https://s0graphql0org.icopy.site/)獲得[GraphQL 的簡介](https://s0graphql0org.icopy.site/) . * GitLab 支持廣泛的資源，在[GraphQL API Reference 中](reference/index.html)列出. #### GraphiQL[](#graphiql "Permalink") 使用交互式[GraphiQL](https://gitlab.com/-/graphql-explorer)瀏覽器瀏覽 GraphQL API，或在`https://<your-gitlab-site.com>/-/graphql-explorer`上的自管理 GitLab 實例上`https://<your-gitlab-site.com>/-/graphql-explorer` . 有關 GraphiQL Explorer 的更多信息，請參見[GitLab GraphQL 概述](getting_started.html#graphiql) . ## What is GraphQL?[](#what-is-graphql "Permalink") [GraphQL](https://s0graphql0org.icopy.site/)是 API 的查詢語言，它允許客戶端準確地請求他們所需的數據，從而有可能在有限數量的請求中獲得所有必需的數據. 可以以類型的形式描述 GraphQL 數據（字段），從而允許客戶端使用[客戶端 GraphQL 庫](https://s0graphql0org.icopy.site/code/)來使用 API??并避免手動解析. 由于沒有固定的端點和數據模型，因此可以在不進行重大更改的情況下將新功能添加到 API. 這使我們可以擁有[GraphQL 文檔](https://s0graphql0org.icopy.site/learn/best-practices/)中[所述的無](https://s0graphql0org.icopy.site/learn/best-practices/)版本 API. ## Vision[](#vision "Permalink") 我們希望 GraphQL API 是與 GitLab 進行編程交互的**主要**方式. 為此，它需要全面覆蓋-REST API 中可能的一切在 GraphQL API 中也應該可行. 為了幫助我們實現這一愿景，前端應優先使用 GraphQL 而不是 REST API 的新功能. There are no plans to deprecate the REST API. To reduce the technical burden of supporting two APIs in parallel, they should share implementations as much as possible. ## Available queries[](#available-queries "Permalink") GraphQL API 在根級別包含以下查詢： 1. `project` ：項目信息及其許多關聯，例如問題和合并請求. 2. `group` ：基本組信息和史詩目前受支持. 3. `user` ：有關特定用戶的信息. 4. `namespace` ：在名稱空間內，也可以提取`projects` . 5. `currentUser` ：有關當前登錄用戶的信息. 6. `users` ：有關用戶集合的信息. 7. `metaData` ：有關 GitLab 和 GraphQL API 的元數據. 8. `snippets` ：當前登錄用戶可見的`snippets` . 新的關聯和根級別對象正在不斷添加. 有關最新信息，請參見《 [GraphQL API 參考](reference/index.html) 》. 根級查詢在[`app/graphql/types/query_type.rb`](https://gitlab.com/gitlab-org/gitlab/blob/master/app/graphql/types/query_type.rb) . ### Multiplex queries[](#multiplex-queries "Permalink") GitLab 支持使用[apollo-link-batch-http 將](https://www.apollographql.com/docs/link/links/batch-http/)查詢批量處理為單個請求. GitLab 在后端使用的庫[GraphQL Ruby](https://graphql-ruby.org/queries/multiplex.html)也提供了有關多路查詢的更多信息. ## Reference[](#reference "Permalink") GitLab 的 GraphQL 參考[可用](reference/index.html) . 它是從 GitLab 的 GraphQL 模式自動生成的，并嵌入到 Markdown 文件中. 機器可讀版本也可用： * [JSON format](reference/gitlab_schema.json) * [IDL format](reference/gitlab_schema.graphql)