Download the PHP package philiprehberger/php-api-response without Composer

On this page you can find all versions of the php package philiprehberger/php-api-response. 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 philiprehberger/php-api-response

Informations about the package php-api-response

PHP API Response

Tests Latest Version on Packagist Last updated

Standardized API response builder for consistent JSON APIs.

Requirements

Installation

Usage

Success Responses

Error Responses

Paginated Responses

Serialization

ResponsePayload implements JsonSerializable and Stringable:

Using with Laravel

Return responses directly from controllers by accessing the payload properties:

Fluent Chaining

All with* methods return a new ResponsePayload instance, keeping the original unchanged:

Response Shape

All responses follow a consistent structure:

API

Method Status Code Description
ApiResponse::success($data, $message) 200 Successful response with optional data
ApiResponse::created($data, $message) 201 Resource created successfully
ApiResponse::noContent($message) 204 Success with no response body
ApiResponse::error($message, $statusCode, $errors) 400 Generic error response
ApiResponse::validationError($errors, $message) 422 Validation failure with field errors
ApiResponse::notFound($message) 404 Resource not found
ApiResponse::unauthorized($message, $errors) 401 Authentication required or failed
ApiResponse::forbidden($message, $errors) 403 Authenticated but not permitted
ApiResponse::accepted($data, $message) 202 Request accepted for asynchronous processing
ApiResponse::internalServerError($message, $errors) 500 Unexpected server-side failure
ApiResponse::paginated($items, $total, $page, $perPage) 200 Paginated list with metadata

Fluent Methods on ResponsePayload

Method Description
withMeta(array $meta) Returns a new instance with merged metadata
withHeaders(array $headers) Returns a new instance with custom response headers
withStatusCode(int $code) Returns a new instance with overridden HTTP status code
withPagination(int $total, int $page, int $perPage) Returns a new instance with a pagination block merged into meta

Development

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT

All versions of php-api-response with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
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 philiprehberger/php-api-response contains the following files

Loading the files please wait ...