Codeignier framework implements restful API interface programming

summary

The company interface code uses CodeIgnier frame , So I use CodeIgnier The framework implements a simple restful Style interface .

CodeIgnier The framework has no resource routing by default , Only used in routing HTTP Verbs are as follows ：

In the realization of restful When programming the style interface, you need to define the parameters and types of the route. The specific code is as follows ：

route routes.php Code

// Default controller 
$route['default_controller'] = 'welcome';
// Error page 
$route['404_override'] = '';
// This option can automatically  URL  Hyphens in controllers and methods in （'-'） Convert to underline （'_'）
$route['translate_uri_dashes'] = FALSE;
/* * restful Interface programming  */
// The page display  get request 
$route['api']['get'] = 'api/index';
// Display a piece of data  get request 
$route['api/(:num)']['GET'] = 'api/view/$1';
// Add a piece of data  post request 
$route['api']['POST'] = 'api/add';
// Modify a piece of data  post request 
$route['api/(:num)']['POST'] = 'api/edit/$1';
// Modify the data page display  put request 
$route['api/(:num)']['PUT'] = 'api/edit/$1';
// Delete a piece of data  delete request 
$route['api/(:num)']['DELETE'] = 'api/delete/$1';

Here I think it inconvenient to write so many routes every time , So I wrote a function to generate these routes , It only needs to be called once , The code is as follows ：

/* * restful Interface programming  * params route array  Route array  * params name string restful Routing name  */
function restful(&$route,$name){
    
    // The page display  get request 
    $route[$name]['get'] = $name.'/index';
    // Display a piece of data  get request 
    $route[$name.'/(:num)']['GET'] = $name.'/view/$1';
    // Add a piece of data  post request 
    $route[$name]['POST'] = $name.'/add';
    // Modify a piece of data  post request 
    $route[$name.'/(:num)']['POST'] = $name.'/edit/$1';
    // Modify the data page display  put request 
    $route[$name.'/(:num)']['PUT'] = $name.'/edit/$1';
    // Delete a piece of data  delete request 
    $route[$name.'/(:num)']['DELETE'] = $name.'/delete/$1';
}

$route['default_controller'] = 'welcome';
$route['404_override'] = '';
$route['translate_uri_dashes'] = FALSE;
// Call function generation restful route 
restful($route,'api');

Below I write an example to implement a simple increment 、 Delete 、 Change 、 check

controller Api Code ：

<?php
/** * Created by PhpStorm. * User: wyq * Date: 2021/8/3 * Time: 16:00 */

class Api extends CI_Controller
{
    
    public function __construct()
    {
    
        parent::__construct();
        // Load model 
        $this->load->model('admins_model');
        // Load helper functions, that is, public functions 
        $this->load->helper('common_helper');
    }
    /* *  Get all the data  get request  */
    public function index(){
    
       $data =  $this->admins_model->findAll();
        // Methods in public functions 
       success($data);
    }
    /* *  Get individual data  get request  */
    public function view($id){
    
        $data = $this->admins_model->findOne($id);
        success($data);
    }
    /* *  Add a piece of data  */
    public function add(){
    
        $data = $_POST;
        $data = $this->admins_model->add($data);
        if ($data){
    
            success($data);
        }else{
    
            // Methods in public functions 
            fail($data);
        }
    }
    /* *  Modify a piece of data  */
    public function edit($id){
    
        if ($_POST){
    
            // Modify page logic 
            $data = $_POST;
            $data['id'] = $id;
            $res = $this->admins_model->dell($data);
            if ($res){
    
                success($res);
            }else{
    
                fail($res);
            }
        }else{
    
            // Modify page tactics PUT request 
            $data = $this->admins_model->findOne($id);
            success($data);
        }
    }
    /* *  Delete a piece of data  */
    public function delete($id){
    
       $res = $this->admins_model->del($id);
       success($res);
    }
}

Helper functions ( Public function )common_helper.php Code ：

<?php
/** * Created by PhpStorm. * User: wyq * Date: 2021/8/3 * Time: 17:02 */


/* *  Cryptographic functions  */
function encrypt($data)
{
    
    $salt = "123123asdasdasd";
    $psw = md5($salt . md5($data));
    return $psw;
}

/* *  General response  * @params int code  Response code  * @params string $msg  Response description  * @params string $data  The response data  */
function response($code = 200 , $msg="success" , $data=array()){
    
    $res = array('code'=>$code,'msg'=>$msg,'data'=>$data);
    echo json_encode($res);die;
}

/* *  Successful response  * @params string $msg  Response description  * @params string $data  The response data  */
function success($data=array(),$msg="success",$code = 200){
    
    response($code,$msg,$data);
}

/* *  Failure response  * @params string $msg  Response description  * @params string $data  The response data  */
function fail($code = 500 ,$msg="fail"){
    
    response($code,$msg);
}

Model Admins_model Code ：

<?php
/** * Created by PhpStorm. * User: wyq * Date: 2021/7/16 * Time: 10:26 */

class Admins_model extends CI_Model
{
    
    public function __construct()
    {
    
    	parent::__construct();
        // Load database 
        $this->load->database();
    }


    /* *  Get all the data  */
    public function findAll()
    {
    
        $query = $this->db->get('admins');
        return $query->result_array();
    }

    /* *  Get a piece of data  */
    public function findOne($id)
    {
    
        $this->db->where('id', $id);
        $this->db->select('*');
        $query = $this->db->get('admins');
        return $query->result();
    }

    /* *  Add a piece of data  */
    public function add($data){
    
        $res = $this->db->insert('admins',$data);
        return $res;
    }

    /* *  Modify a piece of data  */
    public function dell($data){
    
        $this->db->where('id',$data['id']);
        return $this->db->update("admins",$data);
    }
    /* *  Delete a piece of data  */
    public function del($id){
    
        $this->db->where('id',$id);
        return  $this->db->delete('admins');
    }
}

Here is the most basic restful Interface routing , And the realization of the controller model , Here I use postman Test whether the interface is successfully implemented , Here I only show one deletion message .

Before operation ：

After the operation ：

Interface returns data ：