How can I define my function when using REST API in CodeIgniter?

Question

I created a controller named Api.php then I extended the Rest_Controller. I noticed that I can only use index_get() when creating a function in this controller

<?php

class Api extends REST_Controller{

    public function __construct()
    {
        parent::__construct();

    }

    public function index_get(){
        $car_id = $this->get('car_id');
        if(!$car_id){

            $this->response("No Car ID specified", 400);

            exit;
        }

        $result = $this->model_getvalues->getCars( $car_id );

        if($result){

            $this->response($result, 200); 

            exit;
        } 
        else{

             $this->response("Invalid Car ID", 404);

            exit;
        }
    }

}

but when I try creating my desired function like getAllCars() instead of index_get() I get an error message telling me unknown function.

How can I define my own function instead of using index_get() when using rest api library in CodeIgniter?

take a look here github.com/chriskacerguis/…, i think you missed this part: the method names will be appended with the HTTP method used to access the request. If you're making an HTTP GET call to /books, for instance, it would call a Books#index_get() method — Atural
– Atural, Commented Sep 19, 2018 at 22:21
I get what you're saying, the thing is can the index_ be dynamic such that I can name a method getCars_get(), getById_get() and so on and so forth — codedgift
– codedgift, Commented Sep 19, 2018 at 22:37
yes, thats exactly what i meant, but to be honest getCars_get is a bit redundant don't you think ? since you have the _get suffix already in there just name your method cars_get() and if you've a post request you can call your method cars_post() - but from outside its always the same namely /cars/ — Atural
– Atural, Commented Sep 20, 2018 at 5:37
the thing is i'm new to using rest api in codeigniter, if i use cars_get() of which it's working, what if i want to fetch based on some conditions, how will i go about that @sintakonte — codedgift
– codedgift, Commented Sep 20, 2018 at 6:16
what do you mean with conditions ? something like /cars/?id=123 ? — Atural
– Atural, Commented Sep 20, 2018 at 6:50

codedgift · Accepted Answer · 2018-09-20 11:31:02Z

1

Thanks i have been able to figure it out, i just found out that the name before the _get is what matters to the url i.e when one has a method like getCars_get, you will have to call it using just getCars without the _get attach to it, it work for me. it means that one can have more than _get method in the API controller.

answered Sep 20, 2018 at 11:31

codedgift

698 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Ferry Sanjaya · Accepted Answer · 2018-09-20 03:08:55Z

0

By default on https://github.com/chriskacerguis/codeigniter-restserver#handling-requests the method is index_get(),another way to use your own method is play with the HTTP GET parameter ex:

if($this->get('car_id') == 'all'){
  //your own function here
}

Or if you really want to create your own method you can refer on this http://programmerblog.net/create-restful-web-services-in-codeigniter/

answered Sep 20, 2018 at 3:08

Ferry Sanjaya

2243 silver badges17 bronze badges

8 Comments

PHP Geek Over a year ago

define it in your route file.try like this route['index_get']='api/index_get';

codedgift Over a year ago

i don't get you @ferry sanjaya

Ferry Sanjaya Over a year ago

did you read that article? if you want custom method like getAllCars() instead of index_get(),you must put suffix '_get' so getAllCars_get(),thats my opinion

codedgift Over a year ago

i have tried that, but it's still throwing an error say unknown method

Ferry Sanjaya Over a year ago

i tried it and works,do you test using postman and using GET request??.. show me your whole code which return error

|

Ayush ASh · Accepted Answer · 2021-11-02 02:30:05Z

0

All you have to do is change function index_get() to getAllCars_get(),

`<?php

class Api extends REST_Controller{

public function __construct()
{
    parent::__construct();

}

public function getAllCars_get(){
    
   //your code
    
}

} ?> ` Like this

edited Nov 2, 2021 at 2:30

answered Oct 31, 2021 at 5:49

Ayush ASh

11 bronze badge

1 Comment

Community Over a year ago

Your answer could be improved with additional supporting information. Please edit to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers in the help center.

Collectives™ on Stack Overflow

How can I define my function when using REST API in CodeIgniter?

3 Answers 3

Comments

8 Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

8 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related