laravel api

Laravel/PHP 后端项目

链接到实时生产版本

欢迎来到我的另一个 API 项目。对于这个项目，我编写、测试并部署了一个 Laravel 应用程序作为全栈项目的一部分，利用了该框架的许多强大功能，包括：

• 外观和辅助函数；
• 用户认证和授权；
• 数据库播种；
• Eloquent ORM 查询生成器；
• 先进的 API 测试工具。

它是做什么用的？

此 API 处理与用户/考生及其考试相关的数据。例如，它允许用户查看有关考试地点、日期、考生姓名等的信息。

关于访问的重要说明

• 确保在对 API 的所有请求中包含Accept: application/json HTTP 标头。
• 大多数 API 功能仅适用于管理员级别用户。要试验此应用程序，您可以使用以@v3.admin结尾的电子邮件注册一个新帐户，这将为您提供完整的管理员权限。

 // To sign up as an admin, make a POST request to https://laravel-php-api.vercel.app/public/api/signup and include a request body in the following format:

        {
		    "name" : " Anna Torpid " ,
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf " ,
		    "password_confirmation" : " dfbdf9suhfd9shf "
        }

// To login, make a POST request to https://laravel-php-api.vercel.app/public/api/login and include a request body in the following format:

        {
		    "email" : " [email protected] " ,
		    "password" : " dfbdf9suhfd9shf "
        }

// The above POST request returns this response. Make sure to include the returned token in the authorisation header of all future requests.

        {
	        "user" : {
		        "id" : 11 ,
		        "name" : " Anna Torpid " ,
		        "email" : " [email protected] "
	        },
	        "token" : " 5|tAujbY9luWTKquNEruGHU7soCXp7MuzVb8WR0VO9 "
        }

注册或登录后，您将获得一个 API 令牌，需要将其附加到您的请求标头中，以确保完全 CRUD 访问。

可用端点

要访问每个端点，请将 URI 片段附加到根端点。您可以通过访问根端点查看更多详细信息。

资源	描述	认证/授权
发布/注册	创建新帐户。	民众
发布/登录	登录现有帐户。	民众
获取/注销/{id}	注销（撤销令牌）。	仅限登录用户
获取/考试	显示所有考试的列表。包括 5 个可选查询参数。	仅限管理员
获取/考试/{id}	获取具体考试。	只能看到自己的考试
PUT /考试/{id}	修改具体考试。	只能编辑自己的考试
获取/考试/搜索/{名称}	特定候选者的子字符串搜索。	仅限管理员
删除/考试/{id}	删除考试。	只能删除自己的考试
获取/用户	获取所有用户的列表。	仅限管理员
获取 /users/{id}/exams	获取用户所有考试的列表	只能看到自己的考试

主要产品特点

• 作为“无服务器函数”部署在 Vercel 上，利用 PHP 运行时来处理应用程序的配置。
• 生产部署链接到由不同提供商远程托管的实时 PSQL 数据库。
• 富有表现力的 Laravel 特定语法和广泛的方法链接，允许更简洁的代码结构。
• 使用 PHPUnit 和 Laravel 流畅的 JSON 语法（基于闭包和 AssertableJson 类）以测试驱动的方式开发。
• 使用 Github Actions 配置的 CI/CD 工作流程进行自动化测试。
• 使用面向对象的 MVC 模式进行架构设计
• 使用 Sanctum 实现的身份验证服务
  • 用户可以注册并登录。
  • 受保护的路由只能由具有有效 API 令牌的用户访问。
• 使用 Laravel 的门实现授权服务，这是一种基于闭包的授权方法。
  • 某些操作仅允许具有特定角色（例如管理员状态）的用户执行。
• 使用 Eloquent ORM 的关系工具定义的关系和模式约束
• 用于开发和测试的SQLite数据库。

项目目录中的主要文件和文件夹

• ./app 包含应用程序的核心逻辑。
  • /app/Http/Controllers 包含请求处理逻辑。
  • app/Models 包含所有模型类，也是我们指定所有可填写字段的地方。
  • app/Providers 包含引导整个应用程序的类。
• ./routes/api.php 是我们简洁定义所有路由（端点）的地方。
• ./tests/Feature 包含应用程序的所有集成测试。
• ./config/database.php 允许您配置数据库连接设置。
• ./database 是另一个非常重要的文件夹。
  • ./database/factories 包含用于为数据库播种的工厂类。
  • ./database/migrations 允许我们修改数据模型
  • ./databse/seeders 包含通过工厂为数据库播种的类。

在本地环境中运行项目

首先，确保您的计算机上安装了 PHP 和 Composer。

最低版本要求： PHP ^8.1 ；作曲家 2.5.4 。

1. 分叉并克隆存储库。

2. cd 到存储库并运行以下 CLI 命令：

    composer update
    composer install
   

3. 将.env.example文件重命名为.env ，删除默认 mysql 连接的变量，并确保添加以下 3 个变量：

    DB_CONNECTION=sqlite
    DB_FOREIGN_KEYS=true
    USE_SQLITE_SYNTAX=like
    DB_DATABASE= this needs to be the absolute path to the sqlite database located in ./database/database.sqlite, e.g. /home/username/mydocuments/laravel-api/database/database.sqlite*
   

4. 要启动本地开发服务器，请运行 Artisan CLI 命令：

    php artisan serve
   

5. 要运行测试套件，请运行 Artisan CLI 命令：

    php artisan test