Paincker

使用Slim框架实现基本的REST API

发表于 分类于 阅读次数： Valine： 本文字数： 2k 阅读时长 ≈ 2 分钟

REST API是一种广泛应用于服务器和客户端之间的网络通信接口设计风格。首先要明确的是，REST是一种API设计风格，或是理解成一种设计思想，而不是一个具体的技术、编程语言等（有点类似于模块化编程思想）。本文参考了一篇国外的文章，简单介绍了使用Slim框架实现基本REST API的过程。

本文参考文章 《How to create REST API for Android app using PHP, Slim and MySQL》

本文源码可在GitHub上下载： https://github.com/jzj1993/Slim-REST-API

需要准备的工具和环境

  • USBWebServer / XAMPP或其他支持PHP的服务器站点软件包（Apache，PHP，MySQL）
    可参考《USBWebserver：快速搭建本地PHP环境的好工具》 http://www.paincker.com/usbwebserver
  • Chrome浏览器 + Advanced Rest Client插件（或其他REST API测试工具）
  • Slim框架程序包，Composer（Slim已经包含在附件的工程源码中，Composer可以不安装）
  • PHP编辑器：例如NetBeans，SublimeText等

新建数据库和数据表

进入phpmyAdmin数据库管理页面，执行如下SQL指令，新建数据库，并初始化数据表。

  1. CREATE DATABASE task_manager;

  2. USE task_manager;

  3. CREATE TABLE IF NOT EXISTS `users` (

  4. `id` int(11) NOT NULL AUTO_INCREMENT,

  5. `name` varchar(250) DEFAULT NULL,

  6. `email` varchar(255) NOT NULL,

  7. `password_hash` text NOT NULL,

  8. `api_key` varchar(32) NOT NULL,

  9. `status` int(1) NOT NULL DEFAULT '1',

  10. `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,

  11. PRIMARY KEY (`id`),

  12. UNIQUE KEY `email` (`email`)

  13. );

  14. CREATE TABLE IF NOT EXISTS `tasks` (

  15. `id` int(11) NOT NULL AUTO_INCREMENT,

  16. `task` text NOT NULL,

  17. `status` int(1) NOT NULL DEFAULT '0',

  18. `created_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,

  19. PRIMARY KEY (`id`)

  20. );

  21. CREATE TABLE IF NOT EXISTS `user_tasks` (

  22. `id` int(11) NOT NULL AUTO_INCREMENT,

  23. `user_id` int(11) NOT NULL,

  24. `task_id` int(11) NOT NULL,

  25. PRIMARY KEY (`id`),

  26. KEY `user_id` (`user_id`),

  27. KEY `task_id` (`task_id`)

  28. );

  29. ALTER TABLE `user_tasks` ADD FOREIGN KEY ( `user_id` ) REFERENCES `task_manager`.`users` (

  30. `id`

  31. ) ON DELETE CASCADE ON UPDATE CASCADE ;

  32. ALTER TABLE `user_tasks` ADD FOREIGN KEY ( `task_id` ) REFERENCES `task_manager`.`tasks` (

  33. `id`

  34. ) ON DELETE CASCADE ON UPDATE CASCADE;

编写程序

由于参考文章中已经对程序进行了介绍，这里跳过此步骤，直接解压源文件到服务器站点的根目录。根据数据库的登录密码，将include/Config.php中数据库的用户名、密码进行修改。

测试

启动服务器，输入如下网址可进入Slim欢迎界面 http://localhost/libs

从浏览器直接输入网址，可进入默认的HelloWorld界面 http://localhost/v1

使用Chrome插件进行REST API测试

根据参考文章中的内容，这里测试register的API，其他API的测试方法一样。启动Chrome的插件Advanced Rest Client，填写相关数据。其中API的网址如下，在Payload中添加字段name，email，password，选择POST方法；最后点击Send按钮，即可发送数据到服务器端。
http://localhost/v1/register

经过处理，就会返回注册成功的消息，如图。

在phpmyAdmin中可以看到，新注册的用户信息已经保存在数据库中了。

相关文章