Download the PHP package xp-forge/rest-api without Composer

On this page you can find all versions of the php package xp-forge/rest-api. 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?

Informations about the package rest-api

Rest APIs

Build status on GitHub XP Framework Module BSD Licence Requires PHP 7.0+ Supports PHP 8.0+ Latest Stable Version

Annotation-based REST APIs

Example

Wire it together in a web application:

Run it using:

Then call curl -i localhost:8080/users/1549.

Parameter sources

Method parameters are automatically extracted from URI segments if their name matches the path segment in the curly braces. For requests without bodies (GET, HEAD, DELETE, OPTIONS), the value is extracted from request parameters. For requests with bodies (POST, PUT and PATCH), the body is deserialized and passed.

To supply the source explicitely, you can use parameter attributes:

Parameter conversions

Parameters can be converted from their input. This library comes with a built-in conversion named SeparatedBy:

The orgunits parameter can now be supplied in the URL as follows: https://example.com/api/trainings/completed?orgunits=A,B and the resulting value inside $orgunits will be ["A", "B"]. User-defined conversions can be supplied by implementing the web.rest.Conversion interface.

Matrix parameters

This library supports parameters inside path segments, e.g. https://example.com/api/trainings/status=COMPLETED;orgunits=A,B/authors:

The resulting value inside $filter will be ["status" => "COMPLETED", "orgunits" => ["A", "B"]].

Return types

Methods can return anything, which is then serialized and written to the response with a "200 OK" status. If you want greater control over the response, you can use the web.rest.Response class. It provides a fluent DSL for handling various scenarios.

Example:

Creation:

Headers:

Body:

Asynchronous invocation

The following code will run the upload function asynchronously, continuing to serve requests while file contents are being transmitted.

See also

https://github.com/thekid/shorturl - URL Shortener service


All versions of rest-api with dependencies

PHP Build Version
Package Version
Requires xp-framework/core Version ^12.0 | ^11.0 | ^10.0 | ^9.0 | ^8.0 | ^7.0
xp-framework/reflection Version ^3.0 | ^2.0
xp-forge/web Version ^4.0 | ^3.0 | ^2.0 | ^1.0
xp-forge/marshalling Version ^2.0 | ^1.0
xp-forge/json Version ^5.0 | ^4.0 | ^3.1
php Version >=7.0.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 xp-forge/rest-api contains the following files

Loading the files please wait ....