PHPackages                             chriskacerguis/codeigniter-restserver - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. chriskacerguis/codeigniter-restserver

ActiveLibrary[API Development](/categories/api)

chriskacerguis/codeigniter-restserver
=====================================

CI Rest Server

3.1.7(1y ago)4.9k605.6k↓29.9%2.8k[1 issues](https://github.com/chriskacerguis/codeigniter-restserver/issues)2MITPHP

Since Sep 8Pushed 1mo ago398 watchersCompare

[ Source](https://github.com/chriskacerguis/codeigniter-restserver)[ Packagist](https://packagist.org/packages/chriskacerguis/codeigniter-restserver)[ RSS](/packages/chriskacerguis-codeigniter-restserver/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)DependenciesVersions (18)Used By (2)Security (1)

CodeIgniter RestServer
======================

[](#codeigniter-restserver)

A fully RESTful server implementation for CodeIgniter 3 using one library, one config file and one controller.

Important

I have published the first "beta" of codeigniter-restserver 4. See the "development" branch. Please be sure to note the system requirments.

Requirements
------------

[](#requirements)

- PHP 7.2 or greater
- CodeIgniter 3.1.11+

Installation
------------

[](#installation)

```
composer require chriskacerguis/codeigniter-restserver
```

Usage
-----

[](#usage)

CodeIgniter Rest Server is available on [Packagist](https://packagist.org/packages/chriskacerguis/codeigniter-restserver) (using semantic versioning), and installation via composer is the recommended way to install Codeigniter Rest Server. Just add this line to your `composer.json` file:

```
"chriskacerguis/codeigniter-restserver": "^3.1"
```

or run

```
composer require chriskacerguis/codeigniter-restserver
```

Note that you will need to copy `rest.php` to your `config` directory (e.g. `application/config`)

Step 1: Add this to your controller (should be before any of your code)

```
use chriskacerguis\RestServer\RestController;
```

Step 2: Extend your controller

```
class Example extends RestController
```

Basic GET example
-----------------

[](#basic-get-example)

Here is a basic example. This controller, which should be saved as `Api.php`, can be called in two ways:

- `http://domain/api/users/` will return the list of all users
- `http://domain/api/users/id/1` will only return information about the user with id = 1

```