Simple PHP API Framework: Create new APIs using controller classes

Recommend this page to a friend!

Download .zip

Info

Example

View files (23)

Download .zip

Reputation

Support forum

Blog

Links

Last Updated		Ratings				Unique User Downloads		Download Rankings
2024-01-27 (19 hours ago)		Not yet rated by the users				Total: Not yet counted		Not yet ranked

Version		License		PHP version		Categories
`api_framework` 1.0		Custom (specified...		5		Web services, PHP 7

Description

Author

Faris AL-Otabi

This package can be used to create new APIs using controller classes.

It provides a base controller class to implement the actions of API calls.

API developers should create base controller sub-classes to implement controller classes that implement the API endpoint actions.

Faris AL-Otabi

Performance

Level

Name:	Faris AL-Otabi `<contact>`
Classes:	13 packages by Faris AL-Otabi
Country:	Saudi Arabia

Level 3

Innovation award

Nominee: 3x

Example


<?php



declare(strict_types=1);



include_once __DIR__ . "/bootstrap.php";



ini_set('display_errors', 1);

error_reporting(E_ALL);



use MY_Framework\TaskController;

use MY_Framework\Auth;

use MY_Framework\Database;

use MY_Framework\TaskGateway;

use MY_Framework\UserGateway;

use MY_Framework\UserController;

use MY_Framework\RefreshTokenGateway;



$database = new Database(

    $_ENV['DB_HOST'],

    $_ENV['DB_NAME'],

    $_ENV['DB_USER'],

    $_ENV['DB_PASS']

);



$user_gateway = new UserGateway($database);



$rtg = new RefreshTokenGateway($database, $secret_key);



$user = new UserController($user_gateway, $codec, $rtg);



$auth = new Auth($user_gateway, $codec);



$auth_needed_routes = ["tasks"];



if (in_array($route, $auth_needed_routes)) {

    $auth->authenticate($_ENV['AUTHENTICATE_BY']);



    $user_id = $auth->getUserId();

}



/** API Router */

switch ($route) {

    case 'tasks':

        $task_gatway = new TaskGateway($database);



        $task_controller = new TaskController($task_gatway, $user_id);



        $task_controller->processRequest($method, $id);



        break;



    case 'register':

        $user->register($method);



        break;



    case 'login':

        $user->login($method);

        break;



    case 'logout':

        $user->logout($method);

        break;



    case 'refresh':

        $user->refresh($method);

        break;



    default:

        http_response_code(404);

        echo json_encode(["message" => "Page not found"]);

        break;

}

Details

API_Framework

A PHP Framework for creating APIs

PHP Version

This project is created using PHP 8.0+

Coding Standard is PSR-12

Installation

$ composer update
$ composer dump-autoload

Import api.sql to your phpmyadmin

Generate 256-bit key from here allkeysgenerator

Update .env file

The system has 2 authentication methods

JWT Token [token]
API Key [key]

After that just create an account using /register endpoint and POST method

$ httpie post http://localhost/api/register name="Root" username="admin" password="admin"

Use the example to create an account

You can reuse the example for any project you want

Enjoy

Example Project

TaskController.php

TaskGateway.php

Are an example project to show how the system work

Also you can reuse the code in it and change it to your specifications

License

MIT

Copyright

2022 - fariscode

Files

File	Role	Description
`api` (3 files)
`example` (2 files)
`src` (1 directory)
`api.sql`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`delete-expired-refresh-tokens.php`	Example	Example script
`envfile`	Data	Auxiliary data
`LICENSE`	Lic.	License text
`README.md`	Doc.	Documentation

Files

api

File	Role	Description
`.htaccess`	Data	Auxiliary data
`bootstrap.php`	Example	Example script
`index.php`	Example	Example script

Files

example

File	Role	Description
`index.html`	Doc.	Documentation
`register.php`	Example	Example script

Files

src

File	Role	Description
`MY_Framework` (10 files, 1 directory)

Files

src

MY_Framework

File	Role	Description
`Exceptions` (2 files)
`Auth.php`	Class	Class source
`BaseController.php`	Class	Class source
`Database.php`	Class	Class source
`ErrorHandler.php`	Class	Class source
`JWTCodec.php`	Class	Class source
`RefreshTokenGateway.php`	Class	Class source
`TaskController.php`	Class	Class source
`TaskGateway.php`	Class	Class source
`UserController.php`	Class	Class source
`UserGateway.php`	Class	Class source