Download the PHP package jeffersongoncalves/laravel-zero-api-client without Composer

On this page you can find all versions of the php package jeffersongoncalves/laravel-zero-api-client. 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 jeffersongoncalves/laravel-zero-api-client

Informations about the package laravel-zero-api-client

![laravel-zero-api-client](https://raw.githubusercontent.com/jeffersongoncalves/laravel-zero-api-client/main/art/jeffersongoncalves-laravel-zero-api-client.png)

laravel-zero-api-client

A small, self-contained base for building REST API client wrappers in Laravel Zero CLI tools. It was extracted from the near-identical HTTP layers of the Bitbucket and Jira CLIs and captures the shared 85%: get/post/put/delete, pagination, Basic/Bearer authentication and consistent JSON error handling on top of Guzzle.

Why

Every API CLI ends up writing the same boilerplate: a Guzzle client, JSON decoding, a "throw a typed exception on 4xx" branch, and a pagination loop. This package owns that boilerplate so each concrete client only describes what is genuinely API-specific:

It has no dependency on any credentials package - authentication is passed in through the constructor.

Installation

Requires PHP ^8.2 and guzzlehttp/guzzle ^7.10.

Usage

1. Define your exception

Extend ApiException. The base extractMessage() already understands the common error shapes (error.message, message, errorMessages); override it only when your API is different.

2. Define your client

Extend AbstractApiClient and implement newApiException() to bind error handling to your exception type.

3. Authentication

Pass null for anonymous access, or override authHeaders() for a custom scheme.

4. Pagination

Pagination differs across APIs, so paginate() takes two callables: one to extract the items from a page, one to describe the next request (or return null to stop).

Cursor pagination (Bitbucket-style next URL):

Offset pagination (Jira-style startAt/maxResults):

Public API

Class Purpose
AbstractApiClient Base client: get, post, put, delete, paginate. Implement newApiException().
ApiException Abstract base exception with fromResponse() / extractMessage() and $statusCode / $response.
Auth Immutable credential: Auth::basic(), Auth::bearer().
AuthType Basic / Bearer enum.

Testing

License

MIT

All versions of laravel-zero-api-client with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
guzzlehttp/guzzle Version ^7.10
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 jeffersongoncalves/laravel-zero-api-client contains the following files

Loading the files please wait ...