最新消息: 新版网站上线了!!!

laravel5.4实现restful api标准风格的API接口开发以及restful架构描述

laravel中可以通过artisan命令创建控制器,那么如何创建一个复合restful标准的控制器类?如何创建一个普通的控制器类?

laravel中通过建立符合restful标准的控制器,在结合路由。来实现restful api功能

实例:

1. 符合restful标准的控制器创建

php artisan make:controller PhotoController --resource

2.普通控制器创建

php artisan make:controller StyleController

说明:命令末尾添加--resource创建restful标准控制器

restful标准的控制器代码以及路由

namespace App\Http\Controllers;
    use Illuminate\Http\Request;
    use App\Http\Requests;
    use App\Http\Controllers\Controller;
    class PostController extends Controller
    {
        /**
         * 显示文章列表.
         *
         * @return Response
         */
        public function index()
        {
            //自己添加一条测试数据
return ['name'=>'liuwenbin','age'=>'30'];
        }
        /**
         * 创建新文章表单页面
         *
         * @return Response
         */
        public function create()
        {
            //
        }
        /**
         * 将新创建的文章存储到存储器
         *
         * @param Request $request
         * @return Response
         */
        public function store(Request $request)
        {
            //
        }
        /**
         * 显示指定文章
         *
         * @param int $id
         * @return Response
         */
        public function show($id)
        {
            //
        }
        /**
         * 显示编辑指定文章的表单页面
         *
         * @param int $id
         * @return Response
         */
        public function edit($id)
        {
            //
        }
        /**
         * 在存储器中更新指定文章
         *
         * @param Request $request
         * @param int $id
         * @return Response
         */
        public function update(Request $request, $id)
        {
            //
        }
        /**
         * 从存储器中移除指定文章
         *
         * @param int $id
         * @return Response
         */
        public function destroy($id)
        {
            //
        }
    }

注册路由,由于这里使用的是laravel5.4 而且实现的目的是开发api接口,所有注册路由子api.php文件中,而不是web.php中

只写这样一个路由就可以了Route::resource('requapi','PostController');因为前端通过url中不同的参数来对应restful中的GET,POST,PUT,DELETE

访问的urlrestful
操作方法
对应PostController
此实例控制器中的方法
路由名称
http://127.0.0.1/laravelapp/public/api/requapiGETindex()requapi.index
http://127.0.0.1/laravelapp/public/api/requapi/createGETcreate()requapi.create
http://127.0.0.1/laravelapp/public/api/requapiPOSTstore(Request $request)
将新创建的文章存储到存储器
requapi.store
http://127.0.0.1/laravelapp/public/api/requapi/{id}GETshow($id)
显示指定内容
requapi.show

restful设计中,表现层其实指的是资源(resources)的表现层

所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实体。你可以用一个URI(统一资源定位符)指向它,每种资源对应一个特定的URI。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或独一无二的识别符。

表现层(Representation)

"资源"是一种信息实体,它可以有多种外在表现形式。我们把"资源"具体呈现出来的形式,叫做它的"表现层"(Representation)。

比如,文本可以用txt格式表现,也可以用HTML格式、XML格式、JSON格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现。

URI只代表资源的实体,不代表它的形式。严格地说,有些网址最后的".html"后缀名是不必要的,因为这个后缀名表示格式,属于"表现层"范畴,而 URI应该只代表"资源"的位置。它的具体表现形式,应该在HTTP请求的头信息中用Accept和Content-Type字段指定,这两个字段才是 对"表现层"的描述。

状态转化(State Transfer)

  访问一个网站,就代表了客户端和服务器的一个互动过程。在这个过程中,势必涉及到数据和状态的变化。

  互联网通信协议HTTP协议,是一个无状态协议。这意味着,所有的状态都保存在服务器端。因此,如果客户端想要操作服务器,必须通过某种手段,让服务器端发生"状态转化"(State Transfer)。而这种转化是建立在表现层之上的,所以就是"表现层状态转化"。

  客户端用到的手段,只能是HTTP协议。具体来说,就是HTTP协议里面,四个表示操作方式的动词:GET、POST、PUT、DELETE。它们分别对应四种基本操作:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源。

综述

综合上面的解释,我们总结一下什么是RESTful架构:

  (1)每一个URI代表一种资源;

  (2)客户端和服务器之间,传递这种资源的某种表现层(Representation);

  (3)客户端通过四个HTTP动词,对服务器端资源进行操作,实现"表现层状态转化"。

误区

  RESTful架构有一些典型的设计误区。

  最常见的一种设计错误,就是URI包含动词。因为"资源"表示一种实体,所以应该是名词,URI不应该有动词,动词应该放在HTTP协议中。

  举例来说,某个URI是/posts/show/1,其中show是动词,这个URI就设计错了,正确的写法应该是/posts/1,然后用GET方法表示show。

  如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。比如网上汇款,从账户1向账户2汇款500元,错误的URI是:

      POST /accounts/1/transfer/500/to/2

  正确的写法是把动词transfer改成名词transaction,资源不能是动词,但是可以是一种服务:

      POST /transaction HTTP/1.1

      Host: 127.0.0.1

      from=1&to=2&amount=500.00

  另一个设计误区,就是在URI中加入版本号:

      http://www.example.com/app/1.0/foo

      http://www.example.com/app/1.1/foo

      http://www.example.com/app/2.0/foo

  因为不同的版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URI。版本号可以在HTTP请求头信息的Accept字段中进行区分(参见Versioning REST Services):

      Accept: vnd.example-com.foo+json; version=1.0

      Accept: vnd.example-com.foo+json; version=1.1

      Accept: vnd.example-com.foo+json; version=2.0


转载请注明:谷谷点程序 » laravel5.4实现restful api标准风格的API接口开发以及restful架构描述