Download the PHP package causal/simple_api without Composer

On this page you can find all versions of the php package causal/simple_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 simple_api

Simple API for TYPO3

Service to route HTTP/REST requests to your own controllers.

BEWARE: This extension is expected to be used by TYPO3 developers and acts as a central hub to route requests to your own business logic.

Features

In addition, this supports dependency injection for your API handlers, you just need to use @inject or methods prefixed by inject, as well-known when programming with Extbase.

Difference with EXT:routing

Unlike EXT:routing, this extension does not force you to map Extbase controller/actions to route segments but instead basically lets you register a "segment" (typically the first one) and then will simply route the whole request to a handle() method within your controller.

Registration of handlers

First of all you should add a dependency within your ext_emconf.php configuration file, either as a real constraint, or as a suggestion, depending on what you prefer:

Then, within ext_localconf.php:

you may register a pattern instead of a fixed route:

Your handler must extend \Causal\SimpleApi\Controller\AbstractHandler.

Handler Keys

The registration array supports various keys:

Payload

Following rules apply with the payload you return from your API handler:

Known Issues and Workaround

Installation

  1. Clone this repository into typo3conf/ext/simple_api:

    Alternatively, you may load it via composer:

  2. Go to Extension Manager and activate extension simple_api

  3. Add a rewrite rule to your .htaccess. E.g.,

    or, if you are using Nginx:

    This will have the effect of using this extension for handling requests starting with api/.

Hint: If you need to support localization (&L=<some-language-uid>), then you should change the suggesting routing above to include the root page uid of your website (&id=<some-uid>). This is needed because localization mode and default language may differ in complex environments and thus cannot be inferred.


All versions of simple_api with dependencies

PHP Build Version
Package Version
Requires php Version >= 5.5.0, <= 7.1.99
typo3/cms-core Version >= 7.6.0, <= 8.9.99
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 causal/simple_api contains the following files

Loading the files please wait ....