whitensa.blogg.se

Ensure the types you need are in the schema.Provide a straight forward way to add new functionalityĪdding to the API is simplified and now involves only a few steps: SOAP Readme Document, and other resources such as the Search Tips are all useful in the context of making a GraphQL request

Caching is more efficient because actual requests map well to cached data.It's up to the application code to provide abstraction over the data itself. Long-term the schema is evolving towards GraphQL queries and mutations mapping roughly 1-to-1 to SOAP commands. Design GoalsĪ few design goals outline how Zimbra GraphQL works: There should be minimal GraphQL abstraction over Zimbra SOAP resources Better Error Handlingīatch and SOAP request Fault errors are now handled properly and exposed through GraphQL as you would expect. In addition, it's completely transparent to use Zimbra GraphQL with plain JavaScript - you just lose the benefits of typed queries. It enables type checking for the complex API data types used in Zimbra. This is a powerful tool when used in application code. Zimbra GraphQL is written in TypeScript and exposes types for the GraphQL queries and mutations. Visit /graphql and check it out! TypeScript Support This is powered internally by Zimbra GraphQL and Apollo. Documentation for queries, mutations, and fields all lives right within GraphiQL. This is incredibly powerful for exploring and debugging a schema.

When running the zm-x-web app, a GraphiQL server is exposed at /graphiql. The initial implementation handles a few common resource changes and inserts them into the cache. Session Header Notification Support (Realtime Updates)Ĭhange notifications via Session Headers keeps the client in sync with changes made elsewhere.

Zimbra GraphQL includes a minimal normalization layer that (a) renames some keys for more clarity, and (b) does some light lossless normalization for things like Booleans (which are strings in Zimbra SOAP). Many of the attributes in Zimbra SOAP are tersely named. Zimbra GraphQL exposes utilities for use with Apollo so that it's a breeze to connect an application to Zimbra GraphQL. When combining this with Apollo's cache, this results in the minimal number of requests and very high network performance. Using two complementary techniques, Query Batching and DataLoader, batching happens automatically and is transparent to the API consumer. Zimbra GraphQL batches requests by default. This schema includes many of the common resources used in Zimbra SOAP commands such as Search, or GetFolder.

Install npm install SchemaĪ GraphQL Schema that maps Zimbra SOAP resources to GraphQL types is a core tenant of Zimbra GraphQL. GraphQL client for making requests against the Zimbra SOAP API.