CodeIgniter怎样创建RESTful API_CodeIgniter创建RESTful API方法【通信】

老伟大大_4085

老伟大大_4085

2026-04-12

379人浏览

原创

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

codeigniter怎样创建restful api_codeigniter创建restful api方法【通信】

如果您正在使用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;

LongShot
LongShot

一款面向长篇内容创作和SEO写作的AI写作工具,可辅助进行文章生成、内容优化和搜索引擎友好的文本制作。

下载

四、集成表单验证库实现输入校验

未经校验的原始输入可能引发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应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

restful api

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3249

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2348

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1280

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1376

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2218

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3560

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

16295

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程