Download the PHP package networkteam/neos-contentapi without Composer
On this page you can find all versions of the php package networkteam/neos-contentapi. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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-contentapi
Networkteam.Neos.ContentApi
Concepts
Site handling
The content API will use the current domain / site of the request, so make sure to call the API via the correct domain when in a multi-site installation.
Extensibility via Fusion
The API responses are declared by Fusion prototypes. This allows for a high degree of flexibility and customization.
Simple API
This package does not offer a complex API for querying nodes. It is mainly focused on rendering pages backed by document nodes when using Neos as a headless CMS. It is also perfect to pair with @networkteam/zebra and supports full editing of nodes with visual editing.
A node can be fetched either by path (for public access) or by context path (for access with preview in workspaces).
Features
- Support for multi-site installations
- Supports dimensions (e.g. for multi-language sites)
- Supports Flowpack.Neos.DimensionResolver for flexible dimension routing
- Supports Neos.RedirectHandler (if installed) and
checkRedirectsis enabled in settings
Configuration
Examples
Adding an API prototype for document node types:
The idea here is to have a .Api prototype for the complete document
node type hierarchy.
Content as well as arbitrary data can be added to the prototype and will be
serialized as JSON.
Extending API site properties
This can be fetched via the /content-api/site endpoint for the current site (depends on domain).
Provide a query for list data
This query can be fetched via the /content-api/query/articles endpoint.
It uses the predefined Networkteam.Neos.ContentApi:Query.FlowQuery to fetch data based on a FlowQuery expression.
Note: For more complex queries, you can create your own query implementation, e.g. based on a search implementation for more efficient queries.
API endpoints
/neos/content-api/documents
Lists available documents with route path / context path and iterating through dimensions.
A different workspace can be selected via workspaceName (needs authentication).
Note: If
Flowpack.Neos.DimensionResolveralready resolved dimensions e.g. based on the domain, then the dimensions are not iterated.
/neos/content-api/document
Render a document given by path or contextPath.
/neos/content-api/node
Render a single node given by contextPath.
/neos/content-api/site
Render site properties independent of a single node.
/neos/content-api/query/{queryName}
Fetch data for a predefined query.
Query Parameters:
params: Parameters for the query (filter, sorting, pagination, etc.). It is dependent on the Fusion implementation which exact parameters are supported.workspaceName: Workspace name for node context (defaults to live)dimensions: Dimensions for node context
Response:
Query implementations should return a JSON result that contains a list of data and meta information:
