Download the PHP package gabylis/api-foundation without Composer

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

Informations about the package api-foundation

gabylis/api-foundation

Opinionated Laravel API base package: structured JSON responses, PHP 8 OpenAPI attribute scaffolding, and an Artisan generator for documented controllers.

Built from real production patterns on Laravel + l5-swagger projects.

Requirements

Installation

1. Install the package

2. Install and publish l5-swagger

3. Publish the OpenAPI info file

This creates app/OpenApi/OpenApiInfo.php — edit it to set your API title, version, server URL, and security scheme:

4. Configure l5-swagger scanning

In config/l5-swagger.php, set the annotations path inside documentations.default.paths:

Note: You only need to scan app/ — the published OpenApiInfo.php lives there. Do not add vendor/gabylis/api-foundation/src to the annotations paths, as the package no longer contains any OpenAPI annotations in the vendor folder.

5. Generate docs

Open http://localhost:8000/api/documentation.

What's included

OpenApiInfo.php (published to app/OpenApi/)

Global OpenAPI metadata — edit freely after publishing. Re-generate docs after any change:

ApiBaseController

Base controller with the ApiResponse trait. All your API controllers extend this:

ApiFormRequest

Base form request that always returns JSON on validation failure — no more 302 redirects from APIs:

Validation error response (always JSON, status 422):

make:api-controller command

Generates a fully documented controller with PHP 8 #[OA\...] attributes for all CRUD methods:

Options:

Option Description
--resource Route resource name (e.g. products). Defaults to snake_case of class name.
--tag OpenAPI tag label shown in Swagger UI.
--namespace Override default namespace (App\Http\Controllers\Api).
--path Override output path (app/Http/Controllers/Api).
--force Overwrite existing file.

Then add the route and regenerate:

Response envelope

Success:

Paginated:

Error:

Available methods

Method Description
sendResponse($data, $message, $status = 200) Standard success response
sendPaginatedResponse($paginator, $message, $resourceClass = null) Paginated response with meta
sendError($message, $data = [], $status = 404) Error response
sendSuccess($message, $status = 200) Success with message only, no data

Full setup checklist

Publishing the stub

To customise the controller generator template:

This creates stubs/api-foundation/api-controller.stub — edit it and the generator will use your version instead of the default.

Running tests

License

MIT

All versions of api-foundation with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
illuminate/support Version ^10.0|^11.0|^12.0
illuminate/routing Version ^10.0|^11.0|^12.0
illuminate/http Version ^10.0|^11.0|^12.0
darkaonline/l5-swagger Version ^8.5
zircote/swagger-php Version ^4.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 gabylis/api-foundation contains the following files

Loading the files please wait ...