APIShift provides a platform with pre-made tools, structure and workflow that can become any API or back-end you want. You can implement architectures such as REST, SOAP or your own application specific implementation. The main idea is to allow developers to build a back-end for any site and application much faster and easier using a simple, extendable and agile architecture and workflow. APIShift is made with performance an efficiency in mind, the platform hides implementation details under simple interfaces and provides data access optimization tools to make you access your data much faster during run-time.
The framework provides the following features:
- Requests: (Status:
Development)- GUI: Combine processes into a controller representing a set of request handlers
- Development: Simply develop your own controllers with functions that handle requests, and APIShift framework will automatically make them accessible.
- Data: (Status:
DevelopmentPlanning)- GUI: Create a database of any kind (relational, document, etc...) using a smart and simple ORM/ODM graphical representation.
- Development: Manage multiple databases and data at any level (Database, Cache, Session and Run-time) using simple pre-made tools.
- Roles: (Status:
Development)- GUI: Create new roles for users, their specific data, relationships and permissions. Attach to roles an authorization process/function.
- Development: Use simple tools for managing and authorizing sessions and their data.
- Processes: (Status:
Development)- GUI: Create processes using a turing-complete chartflow representation of the desired run-time operation that the process represents.
- Development: Simple tools for using processes when needed.
- Permissions: (Status:
Development)- GUI: Attach processes, functions or roles as an authorization mechanism for requests or data.
- Analysis: (Status:
Planning)- GUI: Create smart counters and in-software data and processes trackers, show their results in graphical representations and use smart tools to compare and search data.
- Development: Attach data trackers and counter into any part of the code you want to analyze.
If you want, you can use your own tools, dependencies and modifications, the architecture lets you add on top of it whatever you want to integrate and use.
APIShift is an open-source PHP system that was designed by Sapir Shemer and its releases are maintained by DevShift. If you want to help and join the community, you are more than welcome to contribute. Just visit the DevShift site or contact Sapir in any way you feel comfortable with: LinkedIn, Facebook. Released under the Apache-2.0 license.
- Sapir Shemer as the architect.
- Eran Bodokh as the Front-End lead.
- Ilan Dazanashvili as a key contributor.
Clone the repository, upload it to your server, and then just visit the server through the web - the system will automatically redirect you to the installation page and will install the configurations and database by the data that you provide during installation.
Notice that the configurations file should be writable (in linux: sudo chmod 666 machine/core/Configurations.php should solve this), otherwise installation will return a permission denied error. If the DB schema provided doesn't exist, then the installer will attempt to create the schema, if so, then make sure the DB user provided has the right access to do so, otherwise you can create the schema yourself.
- Web server
- PHP7+
- APCu or Redis or Memcached enabled on your PHP engine
- MySQL
Run the following command to build the custom apache docker image:
docker build . -t apishift.ubuntu.docker
Run this command to Start the containers
docker-compose up
Run this command to Stop the containers
docker-compose down
One of our goals is to provide users access to a full ecosystem of information about the system. Everything from tutorials, documentation and the code design and flow of the system. The purpose of releasing these documents is to help people understand the system fully.
The main folders of the system indicate the basic idea of where development is done:
- Root Folder: Contains the system and displays content to the end user.
- control/: Stores the UI code & style of the control panel of the APIShift system.
- machine/: Stores the Back-End code for the APIShift system.
- UI/: Stores the UI code of the main page - can actually have your own folders with different names to build your app, the UI is just provided by default, so do whatever you want.
- externals/: External dependencies and libraries the APIShift system uses.
- images/: Stores images that the APIShift system uses.
- docs/: Stores HTML pages that provide information and documentation about the system.
And these are the documents that serve as the information infrastructure we set up for users:
- Architecture and design: Provides a map showing the system from the view point of the code, and the developer - Reading this document is the best way to get insight into the system (besides running it and reviewing the code on your own, it's better to start here).
- Documentation: Install the system and navigate to
http://your-server/doc/serverfor server-side documentation. Client-side documentation comming soon. - Tutorial: Comming soon
After Using APIShift to build an API or Back-End logic and controllers, you access the controllers/other parts and features of the system in 2 different ways presented below.
Any request is actually a call to a method of a certain controller. You specify the controller and method in GET form (specifying c for controller and m for method, yes we keep it minimal), and the data you want to pass to the method in any form you like (Whether GET or POST - you define how the function recieves it). Controller methods belonging to the system will always get data into the function in POST form. Usually to keep a standard we recommend you to pass any data to a controller function in POST form even in your own methods. The url of the request should look similar to this:
https://example-site.com/machine/API.php?c=<ControllerName>&m=<MethodName>
Example in JS using the APIShift.js library:
//
APShift.API.request("<Controller Name>", "<Method Name>", { <Request Body> },
function(response) {
/**
* response in an object containing a status and the response data as either a string or an object
*/
// Success message
if(response.status == APIShift.API.status_codes.SUCCESS) APShift.notify(status.data, "success");
// Error message
else if(response.status == APIShift.API.status_codes.ERROR) APIShift.notify(status.data, "error");
// Any other status
else APIShift.notify("Unknown error!", "error");
}
);Notice: Currently this title is out of date and will be updated as soon as development on this usage will complete
APIShift also provides the APIShift.php file which loads the system whenever you include it. This way you can make PHP pages that include the APIShift system and construct the view on server-side instead of calling an API to recieve data and then construct the view (using JS for example). Then any call for a controller done by using the Authorizer::aurthorizeAndRun method to ensure that an authorization process is done for the method call - or you can just place your own authorization processes and triggers.
<?php
include "machine/APIShift.php";
use APIShift\Core\Authorizer as Authorizer;
?>
<h1><? echo Authorizer::authorizeAndRun(APIShift\Controllers\Page::class, "getPageTitle", ["name" => "Home"]); ?></h1>Data on the current versions will be given here
Data on the next versions will be present here