LazyRest4 完全指南

简介

LazyRest,是一个基于Web的类Rest风格API生成器。LazyRest4(以下简称LR4)是为LazyPHP4专门定制的全新设计的版本,但只要简单的修改代码模板,就可以为其他的框架生成代码。

和之前的版本相比,LR4具有以下特性:

  • 直接生成最终代码,更好调试、更高性能。
  • 全新的交互界面,更漂亮和便捷。
  • 按接口而非数据表设计界面,具有更大的灵活性。
  • 本身不需要数据库,项目配置直接保存成文件,方便分享。

请使用Chrome浏览器访问本应用,其他浏览器并未做兼容性处理。

安装

获取源文件

下载安装包,并解压。或者直接Git Clone。
Repo地址: https://github.com/easychen/LazyRest4

将apache指定到对应目录

初始化项目

使用composer安装PHP依赖

使用Bower安装JS依赖

修改URL重写规则

设置默认管理帐号

打开 /config/app.php
修改以下内容

如果配置正常,这时候访问Web根目录,LazyRest就已经可以使用了。

实战指南

为了更好的演示,我们选择一个真实需求来看看LR4到底怎么用。

需求

我们需要一个公司部门内使用的函数共享库。这个共享库位于公司内网,公司员工可以注册帐号,登入帐号以后可以添加、下载、修改和删除函数。添加函数时可以将其设置为私有,这样别人就无法浏览和下载该函数了。

设计MySQL表

我们使用PHPMyAdmin来设计数据表。新建一个库,coderemote。总共两张表,一张user表用来存放开发者帐号、领一张code表,用来存放函数。

user表结构如下:

设计数据表时需要注意以下两点:

  • 每个表需要有id字段,这个字段在查询接口中用于since_id,这个后文详细讲。
  • 每个字段需要添加注释,注释的内容是字段的中文名。

code表结构如下:

为了方便显示,我们对账户名做了冗余(uname)字段,同时通过private字段来标识是否私有。

索引一般在整个API完成后,根据SQL来添加,这里就暂时跳过了。

创建新项目

LR4采用项目文件保存数据,所以使用方式类似软件。已有项目可以直接上传项目文件,然后继续,这里我们直接「创建新项目」。

在设计接口之前,我们需要把数据库配置下。这样在添加字段时,可以便捷的使用数据库的信息。点击顶导航右侧的⚙图标,设置好Mysql信息。注意这个数据库可以是远程的,并不要一定和LR在一台机器上。

点击保存后,LR会连接数据库,并把数据表信息缓存起来。所以如果后续有数据库变动,请再到设置页面,点一遍保存来刷新数据表信息。

创建接口

然后我们来创建接口。首先是帐号注册接口。

一般我会把写操作设置为POST,把读操作设置为GET。这里我并不严格遵守RESTful的规范,因为觉得这样更简单一些。

目标数据表是我们生成SQL时需要操作的数据表,如果要使用联表操作,则目标数据表可以不选。

然后是输入字段和输入过滤代码。简单的说,「输入字段」部分,会帮你自动生成输入过滤代码,包括输入检查,类型转换等。而如果你觉得生成的代码不好用,或者没有把事情做完时,可以在「输入过滤代码」部分进行补充。

然后我们来添加字段,点击「添加新字段」,然后会出现字段设置界面。因为是LazyRest,所以当然不会让你挨个手工去填写,我们在右边做了快速输入。在「来自数据库」tab下,选择「user」表,然后选上Email字段,点「填至左侧」,LR会根据数据表信息自动填上一部分信息。

因为email字段设置为了not null,所以检查函数默认启用了check_not_empty。但是则会这个函数不够强,我们需要检查是否为email,所以我们自己写一个,先把名字写上(注意LP4中的检查函数必须以check_开头,过滤函数则没有限制):

保存好。LR也直接提供了公共函数的在线编写界面,点击顶导航第二个图标🖋,会弹出代码编辑图层。

保存后,点右上角关掉。接着再把其他帐号注册接口需要的字段添进来。
我们不希望密码明文存储,所以我们在输入过滤代码中对它进行sha1编码(生产环境需要更强的密码策略)。

这样输入部分就完成。接下来看业务逻辑代码。LR预置了添加、修改、列表、删除四大内业务逻辑模板,这些模板你都可以在/codetpl/code目录下进行修改。

这里我们选添加,添加模板预置了唯一字段检查逻辑。在我们的需求里,email字段是唯一的。于是把email字段加上。

这样核心逻辑就完成了。为了方便使用,在预置逻辑里,添加、修改和删除都会返回对应的那条数据的信息(用于提示,某某数据已经删除之类)。

所以这里还用到输出字段和输出过滤代码。这输入很像,但记住password字段其实是不需要返回的。

选完以后我们就可以保存接口了。

生成和测试代码

点击顶导航右三图标,代码会生成到controller目录下的LazyRestController.php。为了调试和部署方便,LR目前所有代码都放到这个文件里。

这时候就可以开始测试了。

如果路由没有更新,请记得把LazyPHP4的自动重建路由开关打开。在/config/app.php中

测试接口

我一般使用PostMan来测试API,所以以下以它为例。

注意几个点:

  • 我们设置了这个接口只支持POST,所以用GET会提示404
  • LazyPHP4.5开始因为支持了Web界面,所以要在添加一个特殊的Header才能强制返回json。

填好参数,接口已经正常工作了。

授权机制

在这个项目里,我们采用token机制:通过email和密码换取一个token,需要授权的接口,带上这个token来访问。

首先我们来做这个接口,在LR中再新建一个。顺便说句,点击这个图标就可以返回接口列表。

将email和password添加为输入字段,设置为必填。

然后我们这次直接自定义业务逻辑代码

Build一下代码,然后我们来测试。

这里我们直接把session_id当成token返回了。这样可以很好的利用上PHP本身的session机制。

然后我们来做一个需要权限的接口:添加代码,顺便把权限限制加上。

仍然是先设置输入字段。

这里需要注意的是,create_at的值不是来自REQUEST,而是来自php本身的。

将所属table写成「-phpfunction-」,并在过滤函数上填上函数名,LR就会把过滤函数的值返回给这个字段。

顺手在公共函数里把now实现了:

uid和uname来自于也做类似处理,不过它们的值来自session。

最后我们来做权限控制。如果你查看一下生成好的代码,会发现在构造函数中有这么一段:

可以看到,所有授权控制的「任意访问」设置为否的接口,都会通过lazyrest_auth_check函数进行权限检查。但是lazyrest_auth_check函数默认是没定义的,所以默认不生效。我们只需要在公共函数中把这个函数实现了,就完成了权限控制。

先看看$this->auth()的实现,在/controller/AuthedContrllor.php里边:

它接受_token参数,并把其作为session id,自动enable了session。所以我们只需要在lazyrest_auth_check里边简单的检查下$_SESSION数据是否正常就OK了。

同时,如果对auth函数的实现不满意,可以直接覆盖它的实现。
保存后Build下代码,就可以测试了:

带上token,已经可以访问了。

其他预置接口

修改接口

id和code作为输入字段;业务逻辑代码选「 修改 」,WHERE子句添加id,选完全匹配。

然后因为只有自己才能修改自己的代码,所以在业务逻辑代码中加上权限检查:

注意在UPDATE和DELETE预置模块中,会查询对应的记录,并保存到$last中供使用。

列表接口

列表接口很简单,预置的业务逻辑也是WHERE匹配,和前文一样处理就好。

下边是列表接口支持的参数:

  • _order:asc/dsec。
  • _order_by:字段名。
  • _since_id:从某个id开始返回。
  • _count:每次返回的数据条数,最多1000条。

但上文我们发现了一个问题,私有函数也被列出来。所以我们需要在业务逻辑处,进行调整,给where子句再加一个条件:

要了解如何调整sql的拼接,直接查看生成好的代码是最好的办法。

另外,为了让查询的实现更简单点,LR预置的删除是直接删除,而非标记删除。

CodeRemote项目的LR文件,可以 点击这里查看 ;我还准备了一个只有用户注册和授权验证的LR文件,方便大家直接开始做业务逻辑。

部署

首先你要有一个可以运行的LazyPHP4环境,然后把LazyRestController.php放到controller目录下,再php _build.php 更新下路由就能用了。

其他

继续开发和贡献代码

如果你有兴趣给LR贡献代码,有几个我觉得很值得做的地方供参考:

  • 自动生成API的JS SDK。
  • 自动打包LazyRestController.php,并发布到云平台。可以生成phing文件来完成。
  • 整理并分享LR项目文件,让有同样需求的同学不用重复开发(记得分享的文件要干点数据库信息)。
  • 根据LR项目文件里边的数据库信息,在数据表不存在时,自动创建数据表。

几个开发Tips

  • 访问 /session 页面可以查看全部元数据。
  • 代码模板使用Twig引擎,挺好用的。
  • css使用less完成,php _build.php的时候会自动编译app.less到app.css

捐助

本来只是做来给自己用的,但因为很多同学表示也想用,就放出来了。写文档解释如何使用什么的挺费事,所以当LazyRest帮你节省了时间和精力之后,可以考虑打赏我一点零花钱 😁

微信

支付宝

LazyRest4 完全指南
  1. 你好我安装之后出现404
    我查了一下LR4确实没有这个目录,是不是我什么没有配置好?
    浏览器错误如下:
    Not Found
    The requested URL /login was not found on this server.