codeigniter构建restful api需五步:一、配置http动词路由映射;二、创建专用控制器并按动词命名方法;三、统一json响应头与格式;四、集成表单验证库校验输入;五、可选引入rest server库简化开发。

如果您正在使用CodeIgniter框架开发后端服务,但尚未构建符合REST规范的API接口,则可能是由于缺少路由映射、控制器设计或响应格式统一等关键环节。以下是创建RESTful API的具体方法:
一、配置REST兼容的路由规则
CodeIgniter默认路由不直接支持HTTP动词区分,需通过自定义方式将不同请求方法映射到控制器的不同方法,确保GET/POST/PUT/DELETE语义准确传达至业务逻辑。
1、打开application/config/routes.php文件。
2、添加资源型路由配置,例如针对用户管理的API:
$route['api/users']['get'] = 'users/index';
$route['api/users']['post'] = 'users/create';
$route['api/users/(:num)']['get'] = 'users/view/$1';
$route['api/users/(:num)']['put'] = 'users/update/$1';
$route['api/users/(:num)']['delete'] = 'users/delete/$1';
二、创建专用API控制器并规范方法命名
控制器需明确区分各HTTP动词对应的操作,避免混用index方法处理全部请求,提升可维护性与语义清晰度。
1、在application/controllers目录下新建Users.php文件。
2、继承CI_Controller基类,并定义对应方法:
class Users extends CI_Controller {
public function index() { // 处理GET /api/users,返回用户列表}
public function create() { // 处理POST /api/users,接收并存储新用户}
public function view($id) { // 处理GET /api/users/{id},返回单个用户详情}
public function update($id) { // 处理PUT /api/users/{id},更新指定用户数据}
public function delete($id) { // 处理DELETE /api/users/{id},执行软删或硬删}
}
三、统一设置JSON响应头与输出格式
RESTful API必须返回标准JSON格式且声明Content-Type,避免前端解析失败;同时应屏蔽HTML输出干扰,确保纯数据传输。
1、在控制器构造函数中设置响应类型:
public function __construct() {
parent::__construct();
$this->output->set_content_type('application/json');}
2、在每个方法末尾使用json_encode输出结构化数组:
$data = ['status' => 'success', 'data' => $user_list];
echo json_encode($data);
3、强制终止后续输出,防止意外内容追加:
exit;
四、集成表单验证库实现输入校验
未经校验的原始输入可能引发SQL注入、空值异常或业务逻辑错误,必须在进入数据库操作前完成字段合法性检查。
1、在控制器方法内加载表单验证库:
$this->load->library('form_validation');
2、设定校验规则,例如注册时验证邮箱与密码:
$this->form_validation->set_rules('email', 'Email', 'required|valid_email');
$this->form_validation->set_rules('password', 'Password', 'required|min_length[6]');
3、执行校验并返回错误信息(状态码400):
if ($this->form_validation->run() === FALSE) {
$error = array('error' => validation_errors());
$this->output->set_status_header(400);
echo json_encode($error);
exit;
}
五、使用第三方REST Server库快速搭建
CodeIgniter官方未内置完整REST支持,引入philsturgeon/codeigniter-restserver可获得HTTP状态码封装、自动解析输入、ACL控制等高级能力,大幅缩短开发周期。
1、通过Composer安装依赖:
composer require chriskacerguis/codeigniter-restserver
2、将REST_Controller.php复制至application/libraries目录。
3、创建控制器继承REST_Controller而非CI_Controller:
class Api_users extends REST_Controller {
public function users_get() { // 自动绑定GET请求
$this->response(['users' => $this->user_model->get_all()], REST_Controller::HTTP_OK);
}
public function users_post() { // 自动绑定POST请求
$input = $this->post();
$result = $this->user_model->insert($input);
$this->response(['id' => $result], REST_Controller::HTTP_CREATED);
}
}
大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!











