Download the PHP package premiervirtual/json-api without Composer
On this page you can find all versions of the php package premiervirtual/json-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 json-api
Description
A good API is one of most effective ways to improve the experience for your clients. Standardized approaches for data formats and communication protocols increase productivity and make integration between applications smooth.
This framework agnostic package implements JSON API specification version v1.0 and helps focusing on core application functionality rather than on protocol implementation. It supports document structure, errors, data fetching as described in JSON API Format and covers parsing and checking HTTP request parameters and headers. For instance it helps to correctly respond with (HTTP code 415) and (HTTP code 406) to invalid requests. You don't need to manually validate all input parameters on every request. You can configure what parameters are supported by your services and this package will check incoming requests automatically. It greatly simplifies API development and fully support specification. In particular
- Resource attributes and relationships
- Polymorphic resource data and relationships
- Compound documents with inclusion of related resources (circular resource references supported)
- Meta information for document, resources, errors, relationship and link objects
- Parsing HTTP
AcceptandContent-Typeheaders in accordance with RFC 7231 - Parsing parameters for pagination, sorting and filtering
- Sparse fieldsets and customized included paths
- Errors
High code quality and 100% test coverage with 250+ tests. Production ready.
To find out more, please check out the Wiki and Sample App.
“I'm loving how easy it makes it to quickly implement an api”
–Jeremy Cloutier
Full-stack Integration
This package is framework agnostic and if you are looking for practical usage sample you might be interested in Quick start JSON API server application Limoncello App.
The server supports
- CRUD operations for a few sample data models and Users.
- Cross-origin requests (CORS) to API server.
- Authentication (Bearer token) and authorizations for CRUD operations.
- Support for such JSON API features as resource inclusion, pagination and etc.
Sample usage
Assuming you've got an of type you can encode it to JSON API as simple as this
will output
The provides information about resource's attributes and might look like
The first parameter is a PHP predefined JSON constant.
The second parameter is a URL prefix that will be applied to all encoded links unless they have flag set to .
For more advanced usage please check out the Wiki.
Questions?
Do not hesitate to check issues or post a new one.
Need help?
Are you planning to add JSON API and need help? We'd love to talk to you [email protected].
Contributing
If you have spotted any specification changes that are not reflected in this package please post an issue. Pull requests for documentation and code improvements are welcome.
Current tasks are managed with Waffle.io.
There are 2 ways to send pull requests
- small pull requests should be sent to
developbranch as 1 commit - for bigger pull requests (e.g. new features) it's recommended to create an
issuerequesting a new branch for that feature. When a new branch namedfeature/issueXXis created (whereXXis the issue number) you should post pull requests to this branch. When the feature is completed the branch will be squashed and merged todevelopand then tomasterbranches.
License
Apache License (Version 2.0). Please see License File for more information.
