用laravel写一个API

目的

用Laravel写一个API，查询所有的用户信息，示例如下

最起码要跑起来

[
    {
        "id": 1,
        "name": "Sinmu",
        "phone": null,
        "email": "sinmu@example.com",
        "email_verified_at": "2022-03-14T10:58:59.000000Z",
        "weixin_openid": null,
        "weixin_unionid": null,
        "created_at": "2022-03-14T10:58:59.000000Z",
        "updated_at": "2022-04-01T17:56:04.000000Z",
        "avatar": "https://cdn.learnku.com/uploads/images/201710/14/1/ZqM7iaP4CR.png",
        "introduction": null,
        "notification_count": 0,
        "last_actived_at": null
    },
   .
   .
   .
   .

]

步骤

下载Laravel

我这里是通过composer 来下载一个laravel项目，composer create-project laravel/laravel projectname_laravel_API

约定

项目按照路径同意会用{path} 来代替。

比如我们的项目文件路径：{path}/projectname_laravel_API

修改配置文件并添加controller

1. 进入项目文件路径下的 .env文件编辑文件内容，修改数据库的参数
   

2. 通过php artisan make:controller Api/UserController创建一个文件，此时我们可以看到这里多了一个文件
   

3. 我们在里面添加一些方法

   <?php
   
   namespace App\Http\Controllers\Api;
   
   use App\Http\Controllers\Controller;
   use App\Models\User;
   
   class UserController extends Controller
   {
       public function index(){
           return 'index';
       }
   
       public function show(){
           return User::all();
       }
   }
   

在return User::all();的意思是会返回我们数据库中user表中的所有数据

添加API路由

定位到 routes\api.php ,先注释掉已有的代码，并添加如下代码

Route::namespace('Api')
    ->prefix('v1')
    ->name('api.v1.')
    ->group(function(){
    	// 通过{uri}/index 可以访问到 UserController中的index方法
        Route::post('/index','UserController@index')->name('user.index');
        Route::post('/show','UserController@show')->name('user.show');
    });

• namesapce()

  由于我们的逻辑代码是写在app\Http\Controllers\Api里面的，而laravel默认的逻辑代码（命名空间）是这个app\Http\Controllers，一次我们需要namespace('Api')来让请求到 app\Http\Controllers\Api\UserController.php里面的方法。

• prefix()

  前缀功能，如果不添加这前缀的话，我们默认的http请求的资源路径：http://127.0.0.1:8000/api/index, 但是如果添加了的话，资源路径：http://127.0.0.1:8000/api/v1/index

• group()

  参见【路由分组】
  就是为了将同一类的路由归类，分到同一组。
  比如不同的版本，用v1，v2来区分，同时也是一个分组

• name()

  给路由起一个别名，在API里面用到不多，如果laravel做全栈开发的话，前端可以通过这个路由别名来调用不同的方法

开启命名空间自带前缀

定位文件app\Providers\RouteServiceProvider.php
大约在26行的样子，将protected $namespace = 'App\\Http\\Controllers';取消注释即可

启动服务

laravel内置一个服务，可以通过php artisan serve 来启动

此时我们打开postman，来测试一波我们的API
API分别为http://127.0.0.1:8000/api/v1/index 和 http://127.0.0.1:8000/api/v1/show