Download the PHP package ayd/api-response-hyperf without Composer

On this page you can find all versions of the php package ayd/api-response-hyperf. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

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.
Please rate this library. Is it a good library?

Example code of ayd/api-response-hyperf

Informations about the package api-response-hyperf

API Response Hyperf

Hyperf integration for the ayd/api-response-base package. Provides a service class and trait for building consistent JSON API responses with PSR-7 response objects.

Installation

The ConfigProvider is auto-discovered by Hyperf and registers ApiResponse as a dependency.

Usage

1. Dependency Injection

Inject ApiResponse into your controller or service. Call setResponse() with the Hyperf response object before use:

2. Trait (for Controllers)

Use ApiResponseTrait to call response methods directly. The trait expects the controller to have a $this->response property (the Hyperf ResponseInterface, which is auto-injected in Hyperf controllers):

Error Handling

Unlike the Laravel package, all methods return Psr\Http\Message\ResponseInterface — error methods do not throw exceptions. Always return the result:

Available error methods: fail(), error(), badRequest(), unauthorized(), forbidden(), notFound(), unprocessable().

Abilities Resolver

Bind your resolver in a ConfigProvider or dependency configuration:

Hyperf's DI container will auto-inject it into ApiResponse's constructor.

API Reference

Success Methods

Method HTTP Status Return Type
success($data, $message, $meta) 200 ResponseInterface
created($data, $message, $meta) 201 ResponseInterface
updated($data, $message, $meta) 200 ResponseInterface
accepted($data, $message, $meta) 202 ResponseInterface
noContent() 204 ResponseInterface

Error Methods

Method HTTP Status Return Type
fail($code, $message, $data, $meta) configurable ResponseInterface
error($code, $message, $data, $meta) configurable ResponseInterface
badRequest($message, $data) 400 ResponseInterface
unauthorized($message) 401 ResponseInterface
forbidden($message) 403 ResponseInterface
notFound($message) 404 ResponseInterface
unprocessable($message, $data) 422 ResponseInterface

Requirements

License

MIT

All versions of api-response-hyperf with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
ayd/api-response-base Version ^1.0
hyperf/http-server Version ^3.0
psr/http-message Version ^1.0|^2.0
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-hyperf contains the following files

Loading the files please wait ...