前言

前言 - 图1

PhalApi是一个PHP轻量级开源接口框架,助你创造价值!我们不断更新,保持生气;为接口负责,为开源负责!并承诺永久免费!

PhalApi官网请见:www.phalapi.net

最新文档

什么是PhalApi 2.x?

PhalApi,简称π框架,是一个PHP轻量级开源接口框架,专注于接口开发,致力让接口开发更简单。它:

  • 致力于快速、稳定、持续交付有价值的接口服务
  • 关注于测试驱动开发、领域驱动设计、极限编程、敏捷开发
  • 有众多的扩展类库,与更多开源项目一起提供高效便捷的解决方案
  • 支持HTTP、SOAP和RPC协议,可用于快速搭建微服务、RESTful接口或Web Services
    PhalApi现存有两大系列版本。分别是经典的第一代版本,即1.x系列版本,主要是使用了较为古老传统的做法;以及全新的第二代版本,即2.x系列版本,主要区别是:

  • 使用了composer统一管理依赖包

  • 引入了命名空间
  • 遵循PSR-4规范
温馨提示:在本开发文档中,若未特别标明,PhalApi指PhalApi 1.x 版本和PhalApi 2.x 版本。

PhalApi有哪些特点?

PhalApi是一个很酷的开源框架,对它越了解,越能发现它的炫酷所在。以下是部分关键的特性。

特点1:学习成本低

PhalApi始终坚持KISS原则,并遵循Unix哲学中的最小立异原则。除了遵循国际惯例,采用约定俗成的做法,PhalApi还在设计时优先考虑大家所熟悉的方案。例如,接口返回结果格式便是路人皆知的JSON格式。对于刚接触PHP编程语言的初级开发同学,甚至是之前未曾接触过PHP的客户端开发同学,根据以往的学习经验,大部分情况下,可以在一周内完成PhalApi框架的基础学习,并投入到实际项目开发中。

特点2:自动生成的在线接口文档

按框架指定的格式完成接口代码编写后,PhalApi会自动生成在线接口列表文档和在线接口详情文档,以方便客户端实时查看最新的接口签名和返回字段。

自动生成的在线文档主要有两类:

  • 在线接口列表文档前言 - 图2

  • 在线接口详情文档前言 - 图3

特点3:众多可重用的扩展类库

PhalApi框架扩展类库,是各自独立,可重用的组件或类库,可以直接集成到PhalApi开发项目,从而让项目开发人员感受搭建积木般的编程乐趣,降低开发成本。

目前,已经提供的扩展类库有40+个,包括:微信公众号开发扩展、微信小程序开发扩展、支付扩展、上传扩展、Excel表格和Word文档扩展等。

温馨提示:部分扩展类库需要调整移植到PhalApi 2.x风格方能使用。

特点4:活跃的开源社区

PhalApi不是“我们”的框架,而是我们大家每个人的开源框架。PhalApi开源社区非常活跃,除了有1000+人的实时交流群,还有自主搭建的问答社区,以及近百名参与贡献的同学。

PhalApi 2.x的学习资料目前还在陆续补充中,但依然可以参考PhalApi 1.x 版本系列丰富的学习资料,有:开发文档视频教程《初识PhalApi》免费电子书博客教程等。

适用场景与范围

PhalApi代码开源、产品开源、思想开源,请放心使用。

PhalApi适用的场景,包括但不限于:

  • 为移动App(包括iOS、iPad、Android、Windowns Phone等终端)提供接口服务
  • 用于搭建接口平台系统,提供聚合类接口服务,供其他后端系统接入使用
  • 为前后端分离的H5混合页面应用,提供Ajax异步接口
    对于架构无关、专注架构及提升架构这三种情况,PhalApi都能胜任之。

正如其他负责任的开源框架一样,PhlaApi也有其不适宜使用的时机。包括但不限于:

  • 开发CLI项目(但已提供支持命令行项目开发的CLI扩展类库
  • 开发网站项目,即有界面展示和视图渲染(但已提供支持视图渲染的View扩展类库
  • 对数据严谨性要求高,如金融行业的相关项目,毕竟PHP是弱类型语言

    文档目标读者

本开发文档的目标读者是:

  • 初次接触PhalApi框架的开发同学
  • 正在使用PhalApi进行项目开发的同学
  • 任何想了解或学习PhalApi框架的同学

联系我们

关于本开发文档,任何问题,都可反馈到 这里,谢谢!

原文: http://docs.phalapi.net/#/v2.0/tutorial