Download the PHP package cloudmonitor/apiflow without Composer
On this page you can find all versions of the php package cloudmonitor/apiflow. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cloudmonitor/apiflow
More information about cloudmonitor/apiflow
Files in cloudmonitor/apiflow
FAQ
Example:
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 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.
Informations about the package apiflow
Develop RESTful API endpoints fast with rich features such as keyword querying, pagination, etc.
Install
Prepare controllers
Similar to special attributes in Eloquent, such as $fillables, APIFlow allows for custom attributes defined as arrays. This way you can control how your data is exposed through your API.
Methods
Currently APIFlow is intended for RESTful resource listings, that be index or collections and single entries show. It can either be done by specifically referering to a API resource and an Eloquent model:
Or, if as above, the names are following the standard convention, that is App\Http\Controllers\UserController, \App\Http\Resources\User and \App\Models\User:
Likewise you may display a single record.
Shortcuts available are also:
->getIndex()->getShow($id)
Apply extra queries
apply() can be used to apply extra filters, such IDs below 10.
Attributes
Currently 3 attributes are supported:
First attribute (queryColumns) tells APIFlow which columns in the database it can do a full text search. Every column will be a partial search, meaning text can be surrounded to the search string (%string%). The string will also be lower cased to avoid case sensivity.
Second attribute (scopes) allows APIFlow to perform queries towards your model scopes (public function scopeDepartment()). Scopes should only require 2 parameters, the default Builder and the query string parameter. The second parameter will always be cased to the given format. Such as:
Where the scope is:
Will be casted to an array of [1,2].
Available features
Currently the features with APIFlow are:
- Keyword searchin (read above for defining columns):
query=(only works on many/getIndex) - Exlcude IDs, if you want to prevent to query something that already is displayed in ie. a list:
exclude=(only works on many/getIndex) - Set limit of results to output, with an upperlimit at 25:
limit=(only works on many/getIndex) - Load related data to the model. Separated with comma:
with= - Run custom scopes on the model:
scopename= - Only certain IDs (pagination won't work):
only= - Order by columns and direction:
orderBy=id|asc,name|desc,email
