Representational state transfer (REST) or RESTful web services provide a way to exchange data between applications or systems on the Internet. RESTful web service also refers as RESTful API, uses HTTP requests to GET, PUT, POST, and DELETE data across platforms. In present days, RESTful API is an essential component of the web application that ensures supporting multiple devices.<\/p>\n
When the CodeIgniter application requires communicating with another application, RESTful API is needed to integrate into CodeIgniter. Using RESTful API in CodeIgniter<\/b>, you can exchange data between different applications or platforms. This tutorial shows RESTful server implementation for CodeIgniter and you will learn how to create RESTful web services in CodeIgniter 3<\/b>.<\/p>\n
If you are a beginner to CodeIgniter, first see CodeIgniter from Scratch tutorial<\/a> to set up and configure the CodeIgniter application.<\/p>\n In this example CodeIgniter REST Server<\/b> application, we will implement CRUD operations<\/a> with REST API in the CodeIgniter web service. The following tasks will be performed to create a simple REST API in CodeIgniter.<\/p>\n Before getting started, take a look at the file structure of CodeIgniter REST API.<\/p>\n You need to create a database that can be used for this application. After that, run the SQL command below to create tables in the database.<\/p>\n 1.<\/b> Use the following SQL statement to create the For now, run the following SQL statement to add the default API settings in the Note that:<\/span> We have added 2.<\/b> Use the following SQL statement to create the “users” table in the MySQL database where the user’s information will be stored.<\/p>\n This REST_Controller is a custom library that helps to implement RESTful server in CodeIgniter. Follow the below steps to set up REST Controller Library in the CodeIgniter application.<\/p>\n 1. REST config:<\/b> The configurations related to the REST_Controller library are defined in the rest.php<\/a> file and placed it in the In the REST Login Source:<\/u> If login authentication is required, set the source.<\/p>\n REST Login Credentials:<\/u> Specify the API login usernames and passwords in an array.<\/p>\n REST Enable Keys:<\/u> When set to TRUE, the REST API will look for a column name called 2. REST Controller:<\/b> Place the REST_Controller.php<\/a> file in the 3. Format Library:<\/b> Place the Format.php file<\/a> in the \n
codeigniter_restserver\/<\/span>\r\n\u251c\u2500\u2500 application\/<\/span>\r\n \u251c\u2500\u2500 config\/<\/span>\r\n | \u2514\u2500\u2500 rest.php\r\n \u251c\u2500\u2500 controllers\/<\/span>\r\n | \u2514\u2500\u2500 Api.php\r\n \u251c\u2500\u2500 language\/<\/span>\r\n | \u2514\u2500\u2500 english\/<\/span>\r\n | \u2514\u2500\u2500 rest_controller_lang.php\r\n \u251c\u2500\u2500 libraries\/<\/span>\r\n | \u251c\u2500\u2500 Format.php\r\n | \u2514\u2500\u2500 REST_Controller.php\r\n \u2514\u2500\u2500 models\/<\/span>\r\n \u2514\u2500\u2500 User.php\r\n<\/pre>\nCreate Database Tables<\/h2>\n
keys<\/code> table where the API key and respective settings will be stored.<\/p>\nCREATE<\/span> TABLE<\/span> `keys`<\/span> (\r\n `id`<\/span> int<\/span>(11<\/span>) NOT<\/span> NULL<\/span> AUTO_INCREMENT,\r\n `user_id`<\/span> int<\/span>(11<\/span>) NOT<\/span> NULL<\/span>,\r\n `key`<\/span> varchar<\/span>(40<\/span>) NOT<\/span> NULL<\/span>,\r\n `level`<\/span> int<\/span>(2<\/span>) NOT<\/span> NULL<\/span>,\r\n `ignore_limits`<\/span> tinyint(1<\/span>) NOT<\/span> NULL<\/span> DEFAULT<\/span> 0<\/span>,\r\n `is_private_key`<\/span> tinyint(1<\/span>) NOT<\/span> NULL<\/span> DEFAULT<\/span> 0<\/span>,\r\n `ip_addresses`<\/span> text<\/span> DEFAULT<\/span> NULL<\/span>,\r\n `date_created`<\/span> datetime NOT<\/span> NULL<\/span>,\r\n PRIMARY KEY<\/span> (`id`<\/span>)\r\n) ENGINE<\/span>=InnoDB<\/span> DEFAULT<\/span> CHARSET<\/span>=utf8;<\/pre>\nkeys<\/code> table. These API key settings will be used for REST API authentication.<\/p>\nINSERT<\/span> INTO<\/span> `keys`<\/span> (`id`<\/span>, `user_id`<\/span>, `key`<\/span>, `level`<\/span>, `ignore_limits`<\/span>, `is_private_key`<\/span>, `ip_addresses`<\/span>, `date_created`<\/span>) VALUES<\/span>\r\n(1<\/span>, 0<\/span>, 'CODEX@123'<\/span>, 0<\/span>, 0<\/span>, 0<\/span>, NULL<\/span>, '2023-02-10 13:34:33'<\/span>);<\/pre>\nCODEX@123<\/code> as the API key for this demo application, you should use a secure key for your application in production.<\/p>\nCREATE<\/span> TABLE<\/span> `users`<\/span> (\r\n `id`<\/span> int<\/span>(11<\/span>) NOT<\/span> NULL<\/span> AUTO_INCREMENT,\r\n `first_name`<\/span> varchar<\/span>(50<\/span>) COLLATE<\/span> utf8_unicode_ci NOT<\/span> NULL<\/span>,\r\n `last_name`<\/span> varchar<\/span>(50<\/span>) COLLATE<\/span> utf8_unicode_ci NOT<\/span> NULL<\/span>,\r\n `email`<\/span> varchar<\/span>(50<\/span>) COLLATE<\/span> utf8_unicode_ci NOT<\/span> NULL<\/span>,\r\n `phone`<\/span> varchar<\/span>(20<\/span>) COLLATE<\/span> utf8_unicode_ci DEFAULT<\/span> NULL<\/span>,\r\n `created`<\/span> datetime NOT<\/span> NULL<\/span> DEFAULT<\/span> current_timestamp<\/span>(),\r\n `modified`<\/span> datetime NOT<\/span> NULL<\/span> DEFAULT<\/span> current_timestamp<\/span>(),\r\n `status`<\/span> tinyint(1<\/span>) NOT<\/span> NULL<\/span> DEFAULT<\/span> 1<\/span> COMMENT<\/span> '1=Active | 0=Inactive'<\/span>,\r\n PRIMARY KEY<\/span> (`id`<\/span>)\r\n) ENGINE<\/span>=InnoDB<\/span> DEFAULT<\/span> CHARSET<\/span>=utf8 COLLATE<\/span>=utf8_unicode_ci;<\/pre>\nCodeIgniter REST Controller Library<\/h2>\n
application\/config\/<\/code> directory.<\/p>\napplication\/config\/rest.php<\/code> file, specify the following settings.
\nREST Login:<\/u> Set authorization type for REST API login authentication.<\/p>\n\n
FALSE<\/code> – No login required<\/li>\nbasic<\/code> – Unsecured login<\/li>\ndigest<\/code> – More secure login<\/li>\nsession<\/code> – Check for a PHP session variable<\/li>\n<\/ul>\n$config<\/span>[<\/span>'rest_auth'<\/span>] = <\/span>'basic'<\/span>;<\/span><\/pre>\n\n
''<\/code> – Use config specified in rest.php<\/li>\nldap<\/code> – Use LDAP authentication<\/li>\nlibrary<\/code> – Use an authentication library<\/li>\nrest_auth<\/code> is set to session<\/code> then set the name of the session variable in auth_source<\/code>.<\/li>\n<\/ul>\n$config<\/span>[<\/span>'auth_source'<\/span>] = <\/span>''<\/span>;<\/span><\/pre>\n$config<\/span>[<\/span>'rest_valid_logins'<\/span>] = [<\/span>'admin' <\/span>=> <\/span>'1234'<\/span>];<\/span><\/pre>\nkey<\/code> and compare its value with the given API key.<\/p>\n$config<\/span>[<\/span>'rest_enable_keys'<\/span>] = <\/span>TRUE<\/span>;<\/span><\/pre>\napplication\/libraries\/<\/code> directory.<\/p>\napplication\/libraries\/<\/code> directory.<\/p>\n