hiyan/phpenalva

PHPenalva 是一个用于构建网络应用程序和简单 APIS 的微型 PHP 框架。

1.1.0 2024-01-22 21:40 UTC

This package is auto-updated.

Last update: 2024-09-23 15:20:41 UTC


README

logomarca

概述

PHPenalva 是一个基于模型-视图-控制器(MVC)架构的轻量级 PHP 微型框架。
PHPenalva 以简洁为设计理念,让您能够快速创建 API 和网络应用程序。

注意:该项目目前正在建设中。请耐心等待,我们将努力使其更加完善。

要求

PHP 版本:需要 PHP 7.4 或更高版本。
Web 服务器:您需要一个启用了 URL 重写功能的 Web 服务器。
支持的 Web 服务器:PHPenalva 与 Apache、Nginx 和 IIS 兼容良好。
数据库兼容性:PHPenalva 与 MySQL、MariaDB、PostgreSQL 和 SQLite 兼容。

平台:PHPenalva 可在 Linux、Windows 和 macOS 上使用。

安装

开始使用 PHPenalva 非常简单。
您可以通过在项目目录中运行以下命令使用 Composer 安装它
composer create-project hiyan/phpenalva your_project_name

路由示例

以下是一些您可以在 PHPenalva 应用程序中定义的路由示例

带视图的路由

  • GET /posts: 列出所有帖子。在浏览器中访问它以查看帖子。
  • GET /post/{id}: 查看特定帖子的详细信息。用 URL 中的所需帖子 ID 替换 {id}。

  • 不带视图的路由

  • POST /post: 创建新的帖子。发送 POST 请求到此路由,带有所需参数以创建新帖子。
  • PUT /post/{id}: 更新现有帖子。发送 PUT 请求到此路由,带有所需参数以更新现有帖子。用 URL 中的所需帖子 ID 替换 {id}。
  • DELETE /post/{id}: 删除现有帖子。发送 DELETE 请求到此

    认证路由
    要在 PHPenalva 中使用路由认证,请在路由定义中添加 'auth'。例如:$route[] = ['GET', '/posts', 'PostController@index', 'auth'];。要访问认证路由,您必须通过 /api/login 路由进行登录。如果没有账户,请使用 /user/create 创建一个。然后您可以通过 /api/login 登录您的账户。登录后,您将收到一个访问令牌。您可以使用此令牌来访问认证路由。为此,请将令牌添加到请求的 Authorization 标头中。例如:Authorization: Bearer {token}。用登录后收到的访问令牌替换 {token}。您还可以将令牌用作查询参数。例如:/posts?token={token}。用登录后收到的访问令牌替换 {token}。

    文档

    我们的全面文档可在 {{TODO}} 轻松访问。
    我们正在不断努力改进它,以帮助您充分利用 PHPenalva 的功能。

    贡献

    PHPenalva 是一个开源项目,我们热烈欢迎社区的贡献。
    无论是修复错误、添加新功能还是改进,您的贡献对我们来说都非常宝贵。
    请参阅我们的 CONTRIBUTING.md 以了解如何贡献的指南。

    许可

    PHPenalva 在 MIT 许可证下发布。有关详细信息,请参阅 LICENSE 文件。
    如果您需要任何帮助或有问题,请随时联系我们。

    感谢您选择 PHPenalva 满足您的开发需求!享受使用 PHPenalva 编码! 🚀🌐