Phalcon API 框架应用骨架

0.2.14 2023-07-18 14:39 UTC

README

Phapi 是一个开源的骨架应用,专为快速启动轻量级 Phalcon PHP Rest API 而构建。

在其核心中,它使用 \Phalcon\Mvc\Micro(),并且高度依赖于 Phalcon 的依赖注入容器,它已经容器化,并附带 mysql 服务器和 Portainer 应用以监控服务。使用 .env 来处理所有应用程序配置。

它提供了骨架项目结构和几个常用的 API 模块和组件。

  • 请求和响应对象的 Rest 包装器
  • 路由组件
  • 异常和错误处理
  • 日志记录器(目前支持 Slack 和 Loggly 代理)
  • 性能分析器
  • 访问控制列表 (ACL)
  • 存储库层(带有一些有限的内存缓存层)
  • JWT 身份验证实现,用于颁发和/或验证令牌
  • 事件管理器
  • 注册表
  • Redis JWT 黑名单
  • 通过注解实现的模型缓存层

由于它严重依赖于 phalcon4,请检查文档:https://docs.phalcon.io/4.0/en/introduction

项目使用自定义 Dockerfile 构建 app 并管理所有系统依赖。基础镜像为 debian 10,php 和 phalcon 版本可定制。

项目实现了开源 JSON:API 规范,所有响应/请求格式都已根据 https://jsonapi.fullstack.org.cn/format/ 进行结构化。

更多信息即将推出。

开发信息

如果您使用默认的卷映射,该映射已在 docker-compose.yml 文件中完成,请记住运行 composer-update.sh(在运行 docker-compose up 之前)。