PHP download

Download the PHP package wizards/rest-api without Composer

On this page you can find all versions of the php package wizards/rest-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download wizards/rest-api
More information about wizards/rest-api
Files in wizards/rest-api

Vendor wizards
Package rest-api
Short Description A set of services to help you create beautiful REST APIs
License MIT

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 wizards/rest-api

Informations about the package rest-api

Wizards Technologies' PHP REST API Library

A framework agnostic PHP library based on fractal to help you craft beautiful REST APIs.

Goals

The main goal is to provide an easy to use and powerful REST API library that seamlessly integrates with modern frameworks.

The paradigm reads as follow:

A method will ask for a given resource (usually a controller), sending over an http request that we Parse to find standardized parameters. A resource is a data object, that you can fetch from a data store - as a collection or as an entry. Thoses resources can have relationships, can be filtered, can be modified, ....
The library will fetch the resource(s) according to the given Object Manager (something like an orm, odm) and request
It then transforms the data into standardized resource(s) given the provided Object Reader (there are many ways to configure resources, such as doctrine annotations, configuration files, ...)
It sends the found resources to fractal with the appropriate Transformer for serialization on the given output format.

Installation

Usage

The library's conventions are based on the jsonapi ones.

Query Paramters

The RestQueryParser will expect those query parameters:

Collection
- sort
  - name to sort by ascending name
  - -name to sort by descending name
  - Example: ?sort=-date
- filter to filter resources by values.
  - multiple values for filters should be provided coma-separated.
  - Example: ?filter[name]=dupont,dupond&filter[surname]=thomas
- filteroperator
  - to change the default filter opetator from = to something else.
  - available operators: <, >, <=, >=, !=, in.
  - Example: ?filter[age]=18&filteroperator[age]=>=
- include to include relationships data.
  - Example: /books?include=author,editor
- limit: how many results you want to see by page.
- page: the page number. Starts at 1.
Single resource
- include to include relationships data. Example: /books/1?include=author,editor

Examples

Plain ol' PHP

Symfony

See the documentation on Wizards Technologies' REST API Bundle

Laravel

We are actively looking for laravel developers to support it !

Future plans

Add more tests
Add the sparse fieldset feature
Add advanced filter operators such as like or between
Optimize how the data are fetched from the source.
Think about serialization groups.

All versions of rest-api with dependencies

PHP Build Version

Package Version

Version 0.9.0 Release 17. Jan 2021
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of rest-api from vendor wizards

Requires php Version >=7.3
psr/http-message Version ^1.0
league/fractal Version ^0.19.2
symfony/options-resolver Version ^4.1|^5.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 wizards/rest-api contains the following files

Loading the files please wait ....