infosophie / api
Basic functionality for creating APIs
Maintainers
Requires
- infosophie/tools: ^0.4
README
Infosophie/Api is a collection of API functions for PHP programming.
Infosophie/Api are published under GPL2.0, i.e. it is open source. You may use, change and distribute it but only under the same license (GPL2.0).
Installation
There are 2 ways to install \Api.
1. Installation with Composer
If you know composer
Infosophie/Api is published on Packagist (https://packagist.com) for usage with Composer (https://getcomposer.org/). For installation just add the line
"infosophie/api": "master"
at the require section in your composer.json file:
"require": {
[... other items ...],
"infosophie/api": "master"
}
Composer's autoload method will include the required php files automatically.
If you do not know composer
If you do not know Composer, you definitely should get to know it. It's a very helpful tool if you plan to develop php projects! In short, Composer is a tool to manage online published php libraries (if you happen to know 'apt' from Linux: it's something simliar).
if you want to learn more about Composer, i reccomend to refer to respective ressources on the web, like e.g. https://getcomposer.org/ and to come back when you are familiar with the commands above!
If you don't want to deal with Composer, just continue reading the next chapter.
2. Manual Installation
Download
To install Infosophie\Api manually just download the installation archive from https://go.infosophie.de/infosophie-api
Copy Files to Webserver
Unzip the archive and copy the files to your webserver and extract it to a subfolder of your choice inside your php project. I will refer to the path to this subfolder relative to your php skript as 'path/to/infosophie/tools'.
Include Files
In order to use the methods of Infosophie/Tools, you first need to include/require the respective php files. This can be done by requiring the file include.php in the root folder of Infosophie/Tools. This file recursively will include all the required files:
require_once('path/to/infosophie/api/include.php');