Download the PHP
package ayd/api-response-base without Composer
On this page you can find all versions of the php package
ayd/api-response-base. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
Vendor ayd Package api-response-base Short Description An base API response package for Hyperf or Laravel applications at AYD Company. License
MIT
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
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 PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
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.
Framework-agnostic JSON API response builder. Provides a consistent response envelope with support for pagination metadata, abilities, and request tracing.
Installation
Response Envelope
Every response follows this structure:
The meta key is omitted when empty. data defaults to [] when null. A request_id (UUID v4) is always auto-generated.
Usage
Building Responses
All methods are static and return arrays:
Using Meta
Meta is an immutable value object. All setters return new instances:
Paginator Support
Response::build() automatically detects paginator-like objects via duck typing. Any object implementing total(), perPage(), currentPage(), and items() will have its pagination extracted into meta and data replaced with the items array:
You can also build pagination metadata manually:
Abilities Resolver
Implement AbilitiesResolver to inject authorization flags into every response:
BuildsApiResponse Trait
Provides shared logic for framework-specific implementations:
StatusCode Enum
Requirements
PHP ^8.1
License
MIT
All versions of api-response-base with dependencies
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package ayd/api-response-base contains the following files
Loading the files please wait ...
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.