如何使用PHP编写RESTful接口

MrZONT 发布于2019-06-27 12:00 / 3125人阅读

摘要：但不要担心性能，注释只会在类文件修改后解析一次。接口依赖注入实例配置文件手册请移步

PHPRS@github

这是一个轻量级框架，专为快速开发RESTful接口而设计。如果你和我一样，厌倦了使用传统的MVC框架编写微服务或者前后端分离的API接口，受不了为了一个简单接口而做的很多多余的coding（和CTRL-C/CTRL-V），那么，你肯定会喜欢这个框架！

先举个栗子

写个HelloWorld.php，放到框架指定的目录下（默认是和index.php同级的apis/目录）

/**
 * @path("/hw")
 */
class HelloWorld
{
    /** 
     * @route({"GET","/"})
     */
    public function doSomething() {
        return "Hello World!";
    }
}

浏览器输入http://your-domain/hw/
你将看到：Hello World!就是这么简单，不需要额外配置，不需要继承也不需要组合。

发生了什么

回过头看HelloWorld.php，特殊的地方在于注释（@path，@route），没错，框架通过注释获取路由信息和绑定输入输出。但不要担心性能，注释只会在类文件修改后解析一次。更多的@注释后面会说明。

再看个更具体的例子

这是一个登录接口的例子

/**
 * 用户权限验证
 * @path("/tokens/") 
 */
class Tokens
{ 
    /**
     * 登录
     * 通过用户名密码授权
     * @route({"POST","/accounts/"}) 
     * @param({"account", "$._POST.account"}) 账号
     * @param({"password", "$._POST.password"}) 密码
     * 
     * @throws ({"InvalidPassword", "res", "403 Forbidden", {"error":"InvalidPassword"} }) 用户名或密码无效
     * 
     * @return({"body"})    
     * 返回token，同cookie中的token相同,
     * {"token":"xxx", "uid" = "xxx"}
     *
     * @return({"cookie","token","$token","+365 days","/"})  通过cookie返回token
     * @return({"cookie","uid","$uid","+365 days","/"})  通过cookie返回uid
     */
    public function createTokenByAccounts($account, $password, &$token,&$uid){
        //验证用户
        $uid = $this->users->verifyPassword($account, $password);
        Verify::isTrue($uid, new InvalidPassword($account));
        $token = ...;
        return ["token"=>$token, "uid"=>$uid];
    } 
    /**
     * @property({"default":"@Users"})   依赖的属性，由框架注入
     * @var Users
     */
    public $users;
}

还能做什么

依赖管理（依赖注入），

自动输出接口文档（不是doxgen式的类、方法文档，而是描述http接口的文档）

接口缓存

hook

配合ezsql访问数据库

ezsql是一款简单的面向对象的sql构建工具，提供简单的基本sql操作。
接口

/** @path(/myclass) */
class MyClass{

   /**
    * @route({"GET","/do"})
    * @param({"arg0","$._GET.arg0"})
    */
   public doSomething($arg0){
        return Sql::select("xxx")->from("table_xxx")->where( "xxx = ?", $arg0)->get($this->db);
   }
    /**
     * 依赖注入PDO实例
     * @property
     * @var PDO
     */
    public $db;
}

配置文件

{
    {
        "MyClass":{
            "properties":{
                "db":"@db1"     
            }
        },
    },
    "db1":{
        "singleton":true,
        "class":"PDO",
        "pass_by_construct":true,
        "properties":{
            "dsn":"mysql:host=127.0.0.1;dbname=xxx",
            "username":"xxxx",
            "passwd":"xxxx"           
        }
    },
}

手册

请移步github

服务器托管 idc机房托管 php编写app接口使用php编写的网站 php中平方如何编写 dw如何编写php

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/21366.html

阿北的知识分享小程序中restful使用经验贴

摘要：大家知道我最近在给阿北的知识分享微信小程序改版，使用的是中的功能，接下来把遇到的一些问题及小技巧分享一下。小结以上就是目前为止在使用的开发小程序时候使用的一些知识和技巧，希望对你有用，以后如果有再分享哈。大家知道我最近在给阿北的知识分享微信小程序改版，使用的是yii2中的restful功能，接下来把遇到的一些问题及小技巧分享一下。先安利一下小程序码链接开始分享。 URL要重写 ...

Meils 2019-06-28 18:18 评论0 收藏0
【PhpBoot】为快速开发 RESTful API 设计的PHP框架

摘要：是为快速开发设计的框架。特色框架提供许多主流的特性如依赖注入等。轻松支持是目前最流行的接口文档框架。在一开始就非常注重框架的友好性尽可能让框架保持准确的代码提示。 PhpBoot showImg(https://segmentfault.com/img/remote/1460000004864102);showImg(https://segmentfault.com/img/remot...

mist14 2019-06-28 13:22 评论0 收藏0
用Node编写RESTful API接口

摘要：服务器每收到一条请求，都会用新的和对象触发回调函数。但不会在回调函数被触发之前开始对请求体的解析。在调用完请求回调函数之后，就要由你负责用方法结束响应了见下图。比较常见的情况是当所请求的资源不存在时返回一个状态码。前言本文将通过一个todo list前后端分离的小项目来讲解如何用Node创建符合RESTful风格的API接口。创建HTTP服务器我们先来了解下如何用Node创建H...

Meils 2019-08-22 18:29 评论0 收藏0
用Node编写RESTful API接口

摘要：服务器每收到一条请求，都会用新的和对象触发回调函数。但不会在回调函数被触发之前开始对请求体的解析。在调用完请求回调函数之后，就要由你负责用方法结束响应了见下图。比较常见的情况是当所请求的资源不存在时返回一个状态码。前言本文将通过一个todo list前后端分离的小项目来讲解如何用Node创建符合RESTful风格的API接口。创建HTTP服务器我们先来了解下如何用Node创建H...

gyl_coder 2019-08-02 10:49 评论0 收藏0
PHP相关

摘要：的机器学习库的机器学习库，包括算法交叉验证神经网络等内容。在即将到来的大会上，她将和大家分享在机器学习领域的全新可能。入门总结入门相关，如安装配置基本使用等。基于 Swoole 开发 PHP 扩展 Swoole-1.9.7 增加了一个新特性，可以基于 Swoole 使用 C++ 语言开发扩展模块，在扩展模块中可以注册 PHP 内置函数和类。现在可以基于 Swoole 来编写 PHP ...

lewinlee 2019-06-28 14:39 评论0 收藏0