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. Can you explain to me how works each part of the eschema, or only the things I need to know?īy the informations that I ask above, I think I will be able to fill the schema below and understand better how zimbra webservice works.GraphQL client for making requests against the Zimbra SOAP API. do I need fill all the attributes? (In the schema below). I try use the SOAP UI to test the zimbra soap, but I see there is a lot of information, and I see in the documentation of the ZImbra about soap, and I don't understand well.īelow I will put the schema of the soap ui. I new with zimbra and I try understand more about him before start make the integration.

Zimbra soap api