Download the PHP package wwwision/neos-graphql without Composer
On this page you can find all versions of the php package wwwision/neos-graphql. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download wwwision/neos-graphql
More information about wwwision/neos-graphql
Files in wwwision/neos-graphql
Package neos-graphql
Short Description Experimental GraphQL API for the Neos Content Repository
License GPL-3.0+
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package neos-graphql
Wwwision.Neos.GraphQL
An experimental GraphQL API on top of the Neos Content Repository
Background
This package just comes with a set of GraphQL Type definitions that wrap the public API of the Neos Content Repository. It depends on the Wwwision.GraphQL package to provide the API endpoint and to render the GraphiQL IDE.
Installation
Within an existing Neos instance install the package using composer:
Test whether the GraphQL Playground works by navigating to /neos/graphql.
You should be redirected to the Neos Login form and then back to the GraphiQL interface.
Usage
All the types, queries and mutations are documented and in sync with the PHP API, so this should be pretty self-explanatory if you're familiar with GraphQL and/or with the GraphQL Playground.
Here are some random snapshots of the package in action:
A simple query to fetch a node in live workspace including its sub-pages:
Display other dimensions of a given node:
Move a node into another node and publish the workspace
(Note: this will copy the moved node into the "user-admin" workspace, that can then be published)
Disclaimer
This package was originally created to evaluate the usage of GraphQL to drive the Neos UI. Our current standpoint is: For this very scenario (or if one really needs all the low-level power of this API) this approach might be a viable way. For providing more high-level or public services for unknown clients to be consumed, there are probably better ways, including a good old REST API (btw: GraphQL positions itself as alternative to REST, not as replacement!).
While this package mainly wraps the existing PHP API it is still considered beta, mainly because of a few parts that are likely to change:
- The package key/namespace - I'm not happy with the current name. But if we happen to use it for the Neos Backend this will should be moved to the neos vendor namespace anyways.
- The return types of mutations - Currently they return a
MutationResultwith one success flag. This allows us to change the implementation to be asynchronous without breaking the types. But the current type is not very useful. - Some details of the type definitions might need to be revised
