PHPackages                             nabilsadki/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. nabilsadki/codeigniter-restserver

ActiveLibrary[API Development](/categories/api)

nabilsadki/codeigniter-restserver
=================================

CI Rest Server (Forked from chriskacerguis/codeigniter-restserver)

3.1.1(6y ago)0952MITPHP

Since Sep 8Pushed 1y agoCompare

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

READMEChangelogDependenciesVersions (13)Used By (0)

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

[](#codeigniter-restserver)

[![StyleCI](https://camo.githubusercontent.com/02550895ecbc4637bb8b21d87a675405ee58d51670de1f192305bcac67d94743/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3233303538392f736869656c643f6272616e63683d6d6173746572)](https://github.styleci.io/repos/230589)

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

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

[](#requirements)

- PHP 7.2 or greater
- CodeIgniter 3.1.11+

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

[](#installation)

```
composer require nabilsadki/codeigniter-restserver
```

Usage
-----

[](#usage)

CodeIgniter Rest Server is available on [Packagist](https://packagist.org/packages/nabilsadki/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:

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

or run

```
composer require nabilsadki/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 nabilsadki\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

```