PHP REST API Example: Example API that performs CRUD operations

Recommend this page to a friend!

Download .zip

Info

Example

View files (75)

Download .zip

Reputation

Support forum

Blog

Links

Last Updated		Ratings				Unique User Downloads		Download Rankings
2023-10-31 (2 months ago)		Not enough user ratings				Total: 85 This week: 1		All time: 9,969 This week: 108

Version		License		PHP version		Categories
`php-crud-rest-api` 1.0.0		The PHP License		5		PHP 5, Web services, Design Patterns

Description

Author

Hicri

This package provides an example API that performs CRUD operations.

It shows how to register routes for the API URLs so specific controller classes can handle the requests.

The package can run the API by processing the HTTP requests to the registered endpoint URLs and generating API call responses using view scripts.

Hicri

Performance

Level

Level 1

Innovation award

Nominee: 3x

Example


<?php 





require_once  __DIR__ . '/vendor/autoload.php';

require_once  __DIR__ . '/Controllers/Login.php';

require_once  __DIR__ . '/Controllers/Item.php';







require_once  __DIR__ . '/jwt/vendor/autoload.php';



require_once  __DIR__ . '/models/Database.php';

require_once  __DIR__ . '/Control.php';













// Create Router instance

$router = new \Bramus\Router\Router();



$router->set404(function () {

    header($_SERVER['SERVER_PROTOCOL'] . ' 404 Not Found');

    echo '404, route not found!';

});





$router->get('/', function() {

    echo 'Home Page';

});







/* Login / All - Single - Register - Login Update - Login Delete */





$router->post('/login', 'login@index');

$router->post('/login/all', 'login@all');

$router->post('/login/single', 'login@single');

$router->post('/login/register', 'login@register');

$router->post('/login/update', 'login@update');

$router->post('/login/delete', 'login@delete');





/* Item / All - Single - Create - Update - Delete */





$router->post('/item/all', 'Item@all');

$router->post('/item/single', 'Item@single');

$router->post('/item/create', 'Item@create');

$router->post('/item/update', 'Item@update');

$router->post('/item/delete', 'Item@delete');













$router->run();











?>

Details

PHP- CRUD - Rest API

Single file PHP script that adds a REST API to a MySQL database.

Requirements

- PHP 7.0 or higher with PDO drivers enabled for one of these database systems: - MySQL 5.6 / MariaDB 10.0 or higher for spatial features in MySQL

Configuration

Edit the following lines in the bottom of the file "login.php" and "Item.php":

$vt = $this->Database(
    "Database",
    "localhost",
    "stable",
    "root",
    ""
);

Features

The following features are supported:

- JWT installment - ElastichSearch V2

LOGIN CRUD

The example login table has only a a few fields:

post  
=======
/login     
/login/all  
/login/single
/login/register
/login/update
/login/delete

The CRUD + List operations below act on this table.

Login

To read a record from this table the request can be written in URL format as:

POST /login

Headers

Content-Type : application/json

Body-raw / Json request

{
    "email" : "deneme@gmail.com",
    "password" : "123456",
    "apikey" : "12"

Where "1" is the value of the primary key of the record that you want to read. It will return:

{
    "status":1,
    "jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJsb2NhbGhvc3QiLCJpYXQiOjE2NDY5NDE2MjMsIm5iZiI6MTY0Njk0MTYzMywiZXhwIjoxNjQ2OTQ1MjIzLCJhdWQiOiJteWxvZ2luIiwiZGF0YSI6eyJpZCI6IjEiLCJlbWFpbCI6ImRlbmVtZUBnbWFpbC5jb20iLCJteWFwaWtleSI6IjEyIn19.5ZFqcYSADVaG0BoFBNtxl5nfjCR7d3Wn8JZ0ra-PcJ8","message":"Succesful"

}

On login operations.

Create

To read a record from this table the request can be written in URL format as:

POST /login/register

Headers

Content-Type : application/json
Authorization : Login JWt

Body-raw / Json request

{
    "email":"example@example.com",
    "password":"123456",
    "apikey":"555",
    "status":"1",
    "myapi":"12",
    "secret":"stableDeneme"

Where "1" is the value of the primary key of the record that you want to read. It will return:

{

    "status":1,
    "message":"Succesful"

}

On create operations.

Read - Single

To read a record from this table the request can be written in URL format as:

POST /login/single

Headers

Content-Type : application/json
Authorization : Login JWT

Body-raw / Json request

{
    "id" : "11",
    "myapi" : "12",
    "secret" : "stableDeneme"

Where "1" is the value of the primary key of the record that you want to read. It will return:

{
    "status":1,
    "data":{
        "login_id":"11",
        "login_email":"example@example.com",
        "login_pass":"7c4a8d09ca3762af61e59520943dc26494f8941b",
        "login_apikey":"555",
        "login_status":"1"
        },
    "message":"Succesful"
}

On single read operations.

List

To read a record from this table the request can be written in URL format as:

POST /login/all

Headers

Content-Type : application/json
Authorization : Login JWT

Body-raw / Json request

{
    "myapi" : "12",
    "secret" : "stableDeneme"

Where "1" is the value of the primary key of the record that you want to read. It will return:

{
    "status": 1,
    "data": [
        {
            "login_id": "1",
            "login_email": "deneme@gmail.com",
            "login_pass": "7c4a8d09ca3762af61e59520943dc26494f8941b",
            "login_apikey": "12",
            "login_status": "1"
        },
        {
            "login_id": "10",
            "login_email": "tamamd?r@gmail",
            "login_pass": "7c4a8d09ca3762af61e59520943dc26494f8941b",
            "login_apikey": "998",
            "login_status": "1"
        },
        {
            "login_id": "11",
            "login_email": "example@example.com",
            "login_pass": "7c4a8d09ca3762af61e59520943dc26494f8941b",
            "login_apikey": "555",
            "login_status": "1"
        }
    ],
            "message": "Succesful"
}

On read operations.

Update

To read a record from this table the request can be written in URL format as:

POST /login/update

Headers

Content-Type : application/json
Authorization : Login JWT

Body-raw / Json request

{
     "id": "11",
     "email": "example@example.com",
     "password": "555666777",
     "apikey": "555",
     "status": "1",
     "myapi":"12",
     "secret":"stableDeneme"
}

Where "1" is the value of the primary key of the record that you want to read. It will return:

    "status": 1,
    "message": "Succesful"

}

On update operations.

Delete

To read a record from this table the request can be written in URL format as:

POST /login/delete

Headers

Content-Type : application/json
Authorization : Login JWT

Body-raw / Json request

{
     "id" : "10",
     "myapi" : "12",
     "secret" : "stableDeneme"
}

Where "1" is the value of the primary key of the record that you want to read. It will return:

    "status": 1,
    "message": "Succesful"

}

On delete operations.

Files

File	Role	Description
`.idea` (3 files)
`restAPI` (5 files, 6 directories)
`sql` (1 file)
`app.txt`	Doc.	Documentation
`README.md`	Doc.	Documentation

File	Role	Description
`modules.xml`	Data	Auxiliary data
`php rest.iml`	Data	Auxiliary data
`vcs.xml`	Data	Auxiliary data

File	Role	Description
`Controllers` (2 files)
`helpers` (1 file)
`jwt` (2 files, 1 directory)
`models` (3 files)
`vendor` (1 file, 2 directories)
`views` (10 files)
`.htaccess`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`composer.lock`	Data	Auxiliary data
`Control.php`	Class	Class source
`index.php`	Example	Example script

File	Role	Description
`Item.php`	Class	Class source
`Login.php`	Class	Class source

File	Role	Description
`tool_helper.php`	Example	Example script

File	Role	Description
`vendor` (1 file, 2 directories)
`composer.json`	Data	Auxiliary data
`composer.lock`	Data	Auxiliary data

File	Role	Description
`composer` (11 files)
`firebase` (1 directory)
`autoload.php`	Aux.	Auxiliary script

File	Role	Description
`autoload_classmap.php`	Aux.	Auxiliary script
`autoload_namespaces.php`	Aux.	Auxiliary script
`autoload_psr4.php`	Aux.	Auxiliary script
`autoload_real.php`	Class	Class source
`autoload_static.php`	Class	Class source
`ClassLoader.php`	Class	Class source
`installed.json`	Data	Auxiliary data
`installed.php`	Aux.	Auxiliary script
`InstalledVersions.php`	Class	Class source
`LICENSE`	Lic.	License text
`platform_check.php`	Aux.	Auxiliary script

File	Role	Description
`php-jwt` (3 files, 1 directory)

File	Role	Description
`src` (5 files)
`composer.json`	Data	Auxiliary data
`LICENSE`	Lic.	License text
`README.md`	Doc.	Documentation

File	Role	Description
`BeforeValidException.php`	Class	Class source
`ExpiredException.php`	Class	Class source
`JWK.php`	Class	Class source
`JWT.php`	Class	Class source
`SignatureInvalidException.php`	Class	Class source

File	Role	Description
`Database.php`	Class	Class source
`itemmodel.php`	Class	Class source
`usermodel.php`	Class	Class source

File	Role	Description
`bramus` (1 directory)
`composer` (11 files)
`autoload.php`	Aux.	Auxiliary script

File	Role	Description
`router` (7 files, 4 directories)

File	Role	Description
`demo-multilang` (2 files)
`demo` (2 files)
`src` (1 directory)
`tests` (2 files)
`.php_cs.dist`	Example	Example script
`.travis.yml`	Data	Auxiliary data
`CHANGELOG.md`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`LICENSE`	Lic.	License text
`phpunit.xml.dist`	Data	Auxiliary data
`README.md`	Doc.	Documentation

File	Role	Description
`.htaccess`	Data	Auxiliary data
`index.php`	Class	Class source

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

File	Role	Description
`Bramus` (1 directory)

File	Role	Description
`Router` (1 file)

	php-crud-rest-api-2023-10-31.zip 74KB
	php-crud-rest-api-2023-10-31.tar.gz 53KB
	Install with Composer

Version Control

Unique User Downloads

Download Rankings

100%

Total:	85
This week:	1

All time:	9,969
This week:	108

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.

File	Role	Description
`bootstrap.php`	Aux.	Auxiliary script
`RouterTest.php`	Class	Class source

File	Role	Description
`item-create.php`	Aux.	Auxiliary script
`item-delete.php`	Aux.	Auxiliary script
`item-single.php`	Aux.	Auxiliary script
`item-update.php`	Aux.	Auxiliary script
`login-create.php`	Aux.	Auxiliary script
`login-delete.php`	Aux.	Auxiliary script
`login-list.php`	Aux.	Auxiliary script
`login-single.php`	Aux.	Auxiliary script
`login-update.php`	Aux.	Auxiliary script
`login.php`	Aux.	Auxiliary script