Download the PHP package gearsite/api without Composer
On this page you can find all versions of the php package gearsite/api. 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 api
gearsite/api
A JSON API library for Symfony and Doctrine ORM. It renders Doctrine entities as JSON API documents. It also applies JSON API request bodies back onto those entities.
Install
Symfony Flex registers the bundle for you. The recipe writes this line in config/bundles.php:
NOTE: If you do not use Flex, add that line yourself. Flex configures a package only from its recipe. This package has one.
Quick start
Read docs/quick-start.md to build your first endpoint.
Features
- Serializers — declare the fields and relationships of each entity. Computed fields and role-secured fields are supported.
- Query generation — the library adds the JOINs for computed fields and the sort clause. You supply the pagination and filter strategy.
- Deserialization — apply a JSON API body onto an entity with PATCH semantics.
- Atomic operations — apply a batch of writes in one transaction.
- Security — remove fields and relationships by role, both in the query and in the response.
Supported query parameters:
| Parameter | Example |
|---|---|
| Sparse fieldsets | ?fields[article]=title,body |
| Includes | ?include=comments.author |
| Sort | ?sort=title,-created |
| Pagination | ?page[number]=2&page[size]=25 |
| Filter | ?filter[status]=published |
The library parses page and filter for you. You define what they mean.
Requirements
- PHP 8.2 or later
- Symfony 7.0 or later
- Doctrine ORM 3.0 or later
Documentation
- Quick start — a working endpoint in four steps
- Serializers — fields, relationships, security, and writes
- Atomic operations — batch writes in one transaction
Contributing
Read CONTRIBUTING.md for the setup, the test suites, and the code style.
Security
To report a vulnerability, email [email protected]. Read SECURITY.md for the policy and the scope.
License
MIT. Read LICENSE.
All versions of api with dependencies
doctrine/orm Version ^3.0
doctrine/persistence Version ^3.0 || ^4.0
psr/log Version ^2.0 || ^3.0
symfony/dependency-injection Version ^6.4 || ^7.0 || ^8.0
symfony/http-foundation Version ^6.4 || ^7.0 || ^8.0
symfony/http-kernel Version ^6.4 || ^7.0 || ^8.0
symfony/security-bundle Version ^6.4 || ^7.0 || ^8.0
symfony/stopwatch Version ^6.4 || ^7.0 || ^8.0