Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 2.35 KB

README.md

File metadata and controls

53 lines (42 loc) · 2.35 KB
Raw

ci4_RESTful_API

The simplest possible Codeigniter4 RESTful API based on Representational State Transfer (REST) which is an architectural style for distributed applications, first described by Roy Fielding in his 2000 PhD dissertation, Architectural Styles and the Design of Network-based Software Architectures.

Highlights

  1. This is the simplest form of RESTful API using CodeIGNITER4
  2. Keep in mind that this prototype does not implement any validation or security consideration
  3. Default Codeigniter4 CodeIgniter\RESTful\ResourceController handles return types and Model loading
  4. Browser by default do not support JSON therefor the ResourceController will automatically send it as XML unless you specify otherwise
  5. This API does not handle views. If interested in Pure API not RESTful then check out ci4 UserGuide
  6. This code not thoughtfully tested.

Installation

  1. Have CI4 installed and ready
  2. Add a news table to your database
CREATE TABLE IF NOT EXISTS `news` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `title` varchar(150) COLLATE utf8mb4_unicode_ci NOT NULL,
  `body` mediumtext COLLATE utf8mb4_unicode_ci NOT NULL,
  `created_at` datetime NOT NULL,
  `updated_at` datetime DEFAULT NULL,
  `deleted_at` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;
# ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
  1. Copy and paste NewModel.php to app/Models directory
  2. Copy and Paste News.php to app/Controllers directory
  3. Add $routes->resource('api/news', ['controller' =>'News']); to Config/Route.php
  4. You can access the API using yourDomain/api/news

$routes->resource('api/news', ['controller' =>'News']);

Means:

$routes->get('api/news/new',             'News::new');
$routes->post('api/news',                'News::create');
$routes->get('api/news',                 'News::index');
$routes->get('api/news/(:segment)',      'News::show/$1');
$routes->get('api/news/(:segment)/edit', 'News::edit/$1');
$routes->put('api/news/(:segment)',      'News::update/$1');
$routes->patch('api/news/(:segment)',    'News::update/$1');
$routes->delete('api/news/(:segment)',   'News::delete/$1');

Notes

  • Please if you have any comment or suggestion please do send me a message.