0

0

如何使用 Laravel 创建 REST API

聖光之護

聖光之護

发布时间:2024-10-30 11:27:32

|

676人浏览过

|

来源于dev.to

转载

如何使用 laravel 创建 rest api

您好!在本教程中,我们将在 laravel 中构建一个完整的 rest api 来管理任务。我将指导您完成从设置项目到创建自动化测试的基本步骤。

第 1 步:项目设置

创建一个新的 laravel 项目:

composer create-project laravel/laravel task-api
cd task-api
code .

配置数据库:
在 .env 文件中,设置数据库配置:

db_database=task_api
db_username=your_username
db_password=your_password

生成任务表:
运行命令为任务表创建新的迁移:

php artisan make:migration create_tasks_table --create=tasks

在迁移文件(database/migrations/xxxx_xx_xx_create_tasks_table.php)中,定义表结构:

id();
            $table->string('title');
            $table->text('description')->nullable();
            $table->boolean('completed')->default(false);
            $table->timestamps();
        });
    }

    public function down(): void
    {
        schema::dropifexists('tasks');
    }
};

运行迁移以创建表:

php artisan migrate

第 2 步:创建模型和控制器

为任务创建模型和控制器:

php artisan make:model task
php artisan make:controller taskcontroller --api

定义任务模型(app/models/task.php):





第 3 步:定义 api 路由

在routes/api.php文件中,添加taskcontroller的路由:





第四步:在taskcontroller中实现crud

在taskcontroller中,我们将实现基本的crud方法。

json($tasks, 200);
    }

    public function store(request $request)
    {
        $request->validate([
            'title' => 'required|string|max:255',
            'description' => 'nullable|string'
        ]);
        $task = task::create($request->all());
        return response()->json($task, 201);
    }

    public function show(task $task)
    {
        return response()->json($task, 200);
    }

    public function update(request $request, task $task)
    {
        $request->validate([
            'title' => 'required|string|max:255',
            'description' => 'nullable|string',
            'completed' => 'boolean'
        ]);
        $task->update($request->all());
        return response()->json($task, 201);
    }

    public function destroy(task $task)
    {
        $task->delete();
        return response()->json(null, 204);
    }
}

步骤 5:测试端点(vs code)

现在我们将使用名为 rest client 的 vs code 扩展手动测试每个端点 (https://marketplace.visualstudio.com/items?itemname=humao.rest-client)。如果您愿意,您还可以使用失眠邮递员

安装扩展程序后,在项目文件夹中创建一个包含以下内容的 .http 文件:

巨蟹星云网上商城
巨蟹星云网上商城

一套自助创建网上商店的软件系统,具有界面变幻多彩、功能强大,使用傻瓜化、运行自动化的特点,任何人基本上不用学习,都能快速创建自己的网上商店,用这套系统做一个购物网站,就象做填空题一样容易。采用「巨蟹星云」可以建立诸如:网上花店、网上化妆品店、网上服装店、网上书店、网上点卡店、网上成人用品店、网上玩具店、网上书店、网上手机店、网上数码产品销售店、网上保健品店、网上玩具店、网上车模店、网上音像制品店等

下载
### create new task
post http://127.0.0.1:8000/api/tasks http/1.1
content-type: application/json
accept: application/json

{
    "title": "study laravel"
}

### show tasks
get http://127.0.0.1:8000/api/tasks http/1.1
content-type: application/json
accept: application/json

### show task
get http://127.0.0.1:8000/api/tasks/1 http/1.1
content-type: application/json
accept: application/json

### update task
put http://127.0.0.1:8000/api/tasks/1 http/1.1
content-type: application/json
accept: application/json

{
    "title": "study laravel and docker",
    "description": "we are studying!",
    "completed": false
}

### delete task
delete http://127.0.0.1:8000/api/tasks/1 http/1.1
content-type: application/json
accept: application/json

此文件可让您使用 rest 客户端 扩展直接从 vs code 发送请求,从而轻松测试 api 中的每个路由。

第 6 步:测试 api

接下来,让我们创建测试以确保每条路线按预期工作。

首先,为任务模型创建一个工厂:

php artisan make:factory taskfactory
 fake()->sentence(),
            'description' => fake()->paragraph(),
            'completed' => false,
        ];
    }
}

phpunit 配置:



    
        
            tests/unit
        
        
            tests/feature
        
    
    
        
            app
        
    
    
        
        
        
        
        
        
        
        
        
        
    

创建集成测试:

php artisan make:test taskapitest

在tests/feature/taskapitest.php文件中,实现测试:

postjson('/api/tasks', [
            'title' => 'new task',
            'description' => 'task description',
            'completed' => false,
        ]);

        $response->assertstatus(201);

        $response->assertjson([
            'title' => 'new task',
            'description' => 'task description',
            'completed' => false,
        ]);
    }

    public function test_can_list_tasks()
    {
        task::factory()->count(3)->create();

        $response = $this->getjson('/api/tasks');

        $response->assertstatus(200);

        $response->assertjsoncount(3);
    }

    public function test_can_show_task()
    {
        $task = task::factory()->create();

        $response = $this->getjson("/api/tasks/{$task->id}");

        $response->assertstatus(200);

        $response->assertjson([
            'title' => $task->title,
            'description' => $task->description,
            'completed' => false,
        ]);
    }

    public function test_can_update_task()
    {
        $task = task::factory()->create();

        $response = $this->putjson("/api/tasks/{$task->id}", [
            'title' => 'update task',
            'description' => 'update description',
            'completed' => true,
        ]);

        $response->assertstatus(201);

        $response->assertjson([
            'title' => 'update task',
            'description' => 'update description',
            'completed' => true,
        ]);
    }

    public function test_can_delete_task()
    {
        $task = task::factory()->create();

        $response = $this->deletejson("/api/tasks/{$task->id}");

        $response->assertstatus(204);

        $this->assertdatabasemissing('tasks', ['id' => $task->id]);
    }
}

运行测试

php artisan test

*谢谢! *

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2687

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1663

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1524

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

953

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1420

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1235

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1508

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1306

2023.11.13

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

0

2026.01.20

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Laravel---API接口
Laravel---API接口

共7课时 | 0.6万人学习

PHP自制框架
PHP自制框架

共8课时 | 0.6万人学习

PHP面向对象基础课程(更新中)
PHP面向对象基础课程(更新中)

共12课时 | 0.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号