Download the PHP package shirokovnv/laravel-query-api-backend without Composer

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

Informations about the package laravel-query-api-backend

LaravelQueryApiBackend

Latest Version on Packagist Total Downloads Build Status StyleCI

Unified API for running queries with eloquent models from any http client.

For query data format and usage in frontend see this package

Installation

Via Composer

Usage

Ensure all migrations done

Publish configuration:

Once installed you can do stuff like this in Controller:

$request is Illuminate\Http\Request or Illuminate\Foundation\Http\FormRequest

For available options see config section

Request must contain following keys:

query_data

query_mode

client_request_id

This can be provided in middleware (check example controller and ClientRequestId middleware)

Example controller:

Shirokovnv\LaravelQueryApiBackend\Http\Controllers\QueryApiController

Available query modes:

transaction

runs a couple of queries as a whole. If one of the queries fails, transaction will be rolled back.

multiple

runs a couple of queries individually.

all occurred errors will be added to the error pool with the rest of the result.

Available types of queries:

create

delete

fetch (aka select)

find

update

custom

Authorization

Package provides a way to authorize actions with your queries.

By default no authorization needed.

  1. To switch it on, at first, the model you want to authorize requests for, should implement Shirokovnv\LaravelQueryApiBackend\Support\ShouldAuthorize interface.

The interface is simple and contains one static method:

This function must return array that contains names of abilities, for ex.

Query type names and authorization ability names correlate as:

create -> create

custom -> custom

delete -> delete

fetch -> viewAny

find -> view

update -> update

  1. The second options are default laravel policies for your models.

Each policy contains specific methods, where you feel free to implement any logic for query authorization.

Validation

Each query can be validated the following way:

  1. Use Laravel FormRequest generator for model.

For ex. for App\Models\User create request with name Models\UserRequest

  1. Model should implement Shirokovnv\LaravelQueryApiBackend\Support\ShouldValidate interface

with one static method:

For ex:

Available list of actions is equal to list of query type names.

  1. FormRequest action name to method correlation:

custom, create -> POST

update -> PATCH

delete -> DELETE

find, fetch -> GET

Change log

Please see the changelog for more information on what has changed recently.

Testing

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

MIT. Please see the license file for more information.

All versions of laravel-query-api-backend with dependencies

PHP Build Version
Package Version
Requires illuminate/support Version ~5.8|~6|~7|~8
illuminate/database Version ^5.8|^6.0|^7.0|^8.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 shirokovnv/laravel-query-api-backend contains the following files

Loading the files please wait ....