Help mij met het ontwerpen van een RESTful API in CodeIgniter
description
Met deze prompt kan ik een gestructureerde en efficiënte RESTful API opzetten in CodeIgniter, waardoor ik mijn backend beter kan laten communiceren met frontend of externe applicaties. Het helpt mij configuratiefouten te voorkomen en geeft concrete voorbeelden, wat sneller resultaat oplevert dan zelf uitzoeken.
prompt
Help mij bij het ontwerpen en implementeren van een RESTful API in mijn CodeIgniter-project. Beschrijf de beste aanpak, benodigde configuraties en voorbeeldcode voor mijn A ...
try_prompt
generate_helper
disclaimerOnPageApi
tags
ai_answers
provider: openai
model: gpt-4.1-nano
Natuurlijk! Hieronder vind je een stapsgewijze gids voor het ontwerpen en implementeren van een RESTful API voor gebruikersbeheer in jouw CodeIgniter 3.1.11-project.
### 1. Algemene aanpak
- **Gebruik een aparte controller** voor je API, bijvoorbeeld `Api.php`.
- **Gebruik JSON als data-uitwisseling**.
- **Maak aparte methodes voor CRUD-operaties** (Create, Read, Update, Delete).
- **Zorg voor juiste HTTP-statuscodes**.
- **Implementeer basis authenticatie of beveiliging indien nodig**.
---
### 2. Configuratie
#### a. Autoload en Helpers
- Laad de benodigde helpers en libraries in `application/config/autoload.php`:
```php
$autoload['libraries'] = array('database');
$autoload['helper'] = array('url', 'json');
```
#### b. Routes
- Voeg in `application/config/routes.php` een route toe voor je API:
```php
$route['api/users/(:num)'] = 'api/users/id/$1';
$route['api/users'] = 'api/users';
```
---
### 3. Creëer de API Controller
Maak een nieuw bestand: `application/controllers/Api.php`
```php
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class Api extends CI_Controller {
public function __construct() {
parent::__construct();
$this->load->model('User_model'); // Maak een model voor gebruikers
$this->output->set_content_type('application/json');
}
public function users($id = null) {
if ($this->input->method() == 'get') {
if ($id) {
$user = $this->User_model->get_user($id);
if ($user) {
$this->output->set_output(json_encode($user));
} else {
$this->output->set_status_header(404);
$this->output->set_output(json_encode(['status' => false, 'message' => 'Gebruiker niet gevonden']));
}
} else {
$users = $this->User_model->get_all_users();
$this->output->set_output(json_encode($users));
}
} elseif ($this->input->method() == 'post') {
$data = json_decode($this->input->raw_input_stream, true);
$created = $this->User_model->create_user($data);
if ($created) {
$this->output->set_status_header(201);
$this->output->set_output(json_encode(['status' => true, 'message' => 'Gebruiker aangemaakt']));
} else {
$this->output->set_status_header(400);
$this->output->set_output(json_encode(['status' => false, 'message' => 'Fout bij aanmaken gebruiker']));
}
} elseif ($this->input->method() == 'put' && $id) {
$data = json_decode($this->input->raw_input_stream, true);
$updated = $this->User_model->update_user($id, $data);
if ($updated) {
$this->output->set_output(json_encode(['status' => true, 'message' => 'Gebruiker bijgewerkt']));
} else {
$this->output->set_status_header(400);
$this->output->set_output(json_encode(['status' => false, 'message' => 'Fout bij bijwerken gebruiker']));
}
} elseif ($this->input->method() == 'delete' && $id) {
$deleted = $this->User_model->delete_user($id);
if ($deleted) {
$this->output->set_output(json_encode(['status' => true, 'message' => 'Gebruiker verwijderd']));
} else {
$this->output->set_status_header(400);
$this->output->set_output(json_encode(['status' => false, 'message' => 'Fout bij verwijderen gebruiker']));
}
} else {
$this->output->set_status_header(405);
$this->output->set_output(json_encode(['status' => false, 'message' => 'Method not allowed']));
}
}
}
?>
```
---
### 4. Creëer het model `User_model`
`application/models/User_model.php`:
```php
<?php
class User_model extends CI_Model {
public function get_all_users() {
$query = $this->db->get('gebruikers'); // tabelnaam 'gebruikers'
return $query->result_array();
}
public function get_user($id) {
$query = $this->db->get_where('gebruikers', ['id' => $id]);
return $query->row_array();
}
public function create_user($data) {
return $this->db->insert('gebruikers', $data);
}
public function update_user($id, $data) {
$this->db->where('id', $id);
return $this->db->update('gebruikers', $data);
}
public function delete_user($id) {
return $this->db->delete('gebruikers', ['id' => $id]);
}
}
?>
```
---
### 5. Voorbeeldgebruik van API-endpoints
- **GET alle gebruikers:**
`GET /api/users`
- **GET gebruiker met ID:**
`GET /api/users/1`
- **POST nieuwe gebruiker:**
`POST /api/users` met JSON-body:
```json
{
"naam": "Jan",
"email": "jan@example.com"
}
```
- **PUT update gebruiker:**
`PUT /api/users/1` met JSON-body:
```json
{
"naam": "Jan Updated"
}
```
- **DELETE gebruiker:**
`DELETE /api/users/1`
---
### 6. Samenvatting
- Maak een aparte API-controller.
- Gebruik REST-conventies voor methodes.
- Behandel JSON data.
- Zorg voor juiste HTTP-statuscodes.
- Maak gebruik van een model voor database-operaties.
---
Heb je specifieke wensen of wil je dat ik je help bij het schrijven van een volledige werkende voorbeeldset?
provider: deepseek
model: deepseek-chat
Ik help je graag met het ontwerpen en implementeren van een RESTful API in CodeIgniter 3.1.11 voor gebruikersbeheer. Hier is de complete aanpak:
## 1. Vereiste Configuraties
### application/config/rest.php
```php
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
$config['rest_auth'] = 'basic';
$config['rest_valid_logins'] = ['admin' => 'password'];
$config['rest_enable_keys'] = TRUE;
$config['rest_key_length'] = 40;
$config['rest_key_name'] = 'X-API-KEY';
$config['rest_limits_method'] = 'IP_ADDRESS';
$config['rest_ignore_http_accept'] = FALSE;
$config['rest_ajax_only'] = FALSE;
$config['rest_language'] = 'english';
$config['check_cors'] = TRUE;
$config['allowed_cors_headers'] = ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization'];
$config['allowed_cors_methods'] = ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'];
$config['allow_any_cors_domain'] = TRUE;
```
### application/config/routes.php
```php
$route['api/users']['get'] = 'api/users/index';
$route['api/users/(:num)']['get'] = 'api/users/view/$1';
$route['api/users']['post'] = 'api/users/create';
$route['api/users/(:num)']['put'] = 'api/users/update/$1';
$route['api/users/(:num)']['delete'] = 'api/users/delete/$1';
$route['api/users/(:num)']['options'] = 'api/users/options/$1';
```
## 2. REST Library Installatie
Download de REST-server library:
```bash
wget https://github.com/chriskacerguis/codeigniter-restserver/archive/master.zip
```
Plaas de bestanden in `application/libraries/`
## 3. Database Model
### application/models/User_model.php
```php
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class User_model extends CI_Model {
public function __construct() {
parent::__construct();
$this->load->database();
}
public function get_users($id = null) {
if ($id === null) {
$query = $this->db->get('users');
return $query->result_array();
} else {
$query = $this->db->get_where('users', ['id' => $id]);
return $query->row_array();
}
}
public function create_user($data) {
$this->db->insert('users', $data);
return $this->db->insert_id();
}
public function update_user($id, $data) {
$this->db->where('id', $id);
$this->db->update('users', $data);
return $this->db->affected_rows();
}
public function delete_user($id) {
$this->db->where('id', $id);
$this->db->delete('users');
return $this->db->affected_rows();
}
public function user_exists($id) {
$this->db->where('id', $id);
$query = $this->db->get('users');
return $query->num_rows() > 0;
}
}
```
## 4. API Controller
### application/controllers/api/Users.php
```php
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
require_once APPPATH . '/libraries/REST_Controller.php';
class Users extends REST_Controller {
public function __construct() {
parent::__construct();
$this->load->model('user_model');
$this->load->library('form_validation');
}
// GET /api/users
public function index_get() {
$id = $this->get('id');
if ($id === null) {
$users = $this->user_model->get_users();
if ($users) {
$this->response([
'status' => true,
'data' => $users
], REST_Controller::HTTP_OK);
} else {
$this->response([
'status' => false,
'message' => 'Geen gebruikers gevonden'
], REST_Controller::HTTP_NOT_FOUND);
}
} else {
$user = $this->user_model->get_users($id);
if ($user) {
$this->response([
'status' => true,
'data' => $user
], REST_Controller::HTTP_OK);
} else {
$this->response([
'status' => false,
'message' => 'Gebruiker niet gevonden'
], REST_Controller::HTTP_NOT_FOUND);
}
}
}
// POST /api/users
public function index_post() {
$this->form_validation->set_rules('naam', 'Naam', 'required');
$this->form_validation->set_rules('email', 'Email', 'required|valid_email');
$this->form_validation->set_rules('wachtwoord', 'Wachtwoord', 'required');
if ($this->form_validation->run() == FALSE) {
$this->response([
'status' => false,
'message' => validation_errors()
], REST_Controller::HTTP_BAD_REQUEST);
} else {
$data = [
'naam' => $this->post('naam'),
'email' => $this->post('email'),
'wachtwoord' => password_hash($this->post('wachtwoord'), PASSWORD_DEFAULT),
'aangemaakt_op' => date('Y-m-d H:i:s')
];
$user_id = $this->user_model->create_user($data);
if ($user_id) {
$this->response([
'status' => true,
'message' => 'Gebruiker succesvol aangemaakt',
'data' => ['id' => $user_id]
], REST_Controller::HTTP_CREATED);
} else {
$this->response([
'status' => false,
'message' => 'Kon gebruiker niet aanmaken'
], REST_Controller::HTTP_INTERNAL_SERVER_ERROR);
}
}
}
// PUT /api/users/{id}
public function index_put($id) {
if (!$this->user_model->user_exists($id)) {
$this->response([
'status' => false,
'message' => 'Gebruiker niet gevonden'
], REST_Controller::HTTP_NOT_FOUND);
}
$data = $this->put();
if ($this->user_model->update_user($id, $data)) {
$this->response([
'status' => true,
'message' => 'Gebruiker succesvol bijgewerkt'
], REST_Controller::HTTP_OK);
} else {
$this->response([
'status' => false,
'message' => 'Kon gebruiker niet bijwerken'
], REST_Controller::HTTP_INTERNAL_SERVER_ERROR);
}
}
// DELETE /api/users/{id}
public function index_delete($id) {
if (!$this->user_model->user_exists($id)) {
$this->response([
'status' => false,
'message' => 'Gebruiker niet gevonden'
], REST_Controller::HTTP_NOT_FOUND);
}
if ($this->user_model->delete_user($id)) {
$this->response([
'status' => true,
'message' => 'Gebruiker succesvol verwijderd'
], REST_Controller::HTTP_OK);
} else {
$this->response([
'status' => false,
'message' => 'Kon gebruiker niet verwijderen'
], REST_Controller::HTTP_INTERNAL_SERVER_ERROR);
}
}
// OPTIONS /api/users/{id}
public function index_options($id = null) {
$this->response(null, REST_Controller::HTTP_OK);
}
}
```
## 5. Database Migratie
Maak een users tabel:
```sql
CREATE TABLE users (
id INT(11) AUTO_INCREMENT PRIMARY KEY,
naam VARCHAR(100) NOT NULL,
email VARCHAR(100) NOT NULL UNIQUE,
wachtwoord VARCHAR(255) NOT NULL,
aangemaakt_op DATETIME NOT NULL,
bijgewerkt_op DATETIME DEFAULT NULL
);
```
## 6. Testen met cURL
**Alle gebruikers ophalen:**
```bash
curl -X GET http://jouwdomein.nl/api/users
```
**Specifieke gebruiker ophalen:**
```bash
curl -X GET http://jouwdomein.nl/api/users/1
```
**Nieuwe gebruiker aanmaken:**
```bash
curl -X POST http://jouwdomein.nl/api/users \
-H "Content-Type: application/json" \
-d '{"naam":"Jan Jansen","email":"jan@voorbeeld.nl","wachtwoord":"geheim"}'
```
**Gebruiker bijwerken:**
```bash
curl -X PUT http://jouwdomein.nl/api/users/1 \
-H "Content-Type: application/json" \
-d '{"naam":"Jan Janssen"}'
```
**Gebruiker verwijderen:**
```bash
curl -X DELETE http://jouwdomein.nl/api/users/1
```
## 7. Beveiligingstips
1. **API Keys**: Configureer API-sleutels voor authenticatie
2. **Rate Limiting**: Implementeer request limiting
3. **HTTPS**: Gebruik altijd HTTPS in productie
4. **Input Validatie**: Valideer alle input data
5. **CORS**: Configureer Cross-Origin Resource Sharing
Deze implementatie volgt RESTful principes en biedt een solide basis voor gebruikersbeheer in je CodeIgniter project.