欢迎使用 Apiato

借助 PHP 7.4 和 laravel 6 帮你更快的构建应用接口.

Apiato 是什么

Apiato 是一个基于 PHP 和 Laravel 的框架，它可以帮助我们方便的构建一个可扩展、易测试的、以 API 为中心的应用。我们可以用它提供的基础工具和组件来更快的编写 API。 Apiato 把最棒的框架、工具和开发习惯奇妙的组合在了一起，并提供一系列丰富的功能集合，来帮助我们构建一个现代化的 PHP 应用。 为什么！？ 因为构建 API 是项目的时间消耗大户（没错，时间就是金钱！）。而构建一个健壮且自动文档化的API程序所需的核心功能 Apiato 都可以提供，然后，我们就可以专注于编写我们的业务逻辑代码，来帮助我们更快的向客户提供服务。

功能

Apiato 提供了以下一系列惊人的功能：

软件架构

Apiato 使用了新的软件架构模式 Porto 来构建。

Porto 软件架构模式（SAP） 是一个现代的软件架构模式，这个模式被设计用于帮助开发者以一种超级可维护的方式来组织他们的代码。这对于越来越复杂的大型或者长期项目来说是非常有用的，通过使用 Porto 架构，你可以把你的项目设计成完全 模块化。或者，你也可以继续使用 MVC 的模式来设计你的项目。它同样也可以享受到 Apiato 提供的各种功能。

如何来阅读本文档

本文档工包含 4 个章节：

开始: 包含项目安装的主要步骤.
概述: 包含一些概述性的内容来帮助你理解。
功能: 介绍了 Apiato 各种功能的使用方法、实现原理，和可配置方案。
组件: 介绍了为什么、在哪里和如何使用每一个组件类(class)，在每个组件小节中，你将看到：
- 定义: 这个组件是什么，它的职责又是什么。
- 原则: 这个组件的功能界定是什么，这是一个抽象的功能性描述，你可以用任何的编程语言来实现这个原则。
- 规定: 在 Apiato 架构（即 PHP/Laravel 项目中）中如何优雅的实现这个原则
- 文件目录架构: 文件目录架构是怎样的，你应该把你的组件放在哪里。
- 示例代码: 如何编写和使用这个组件的示例代码。
- 其他: 其他和这个组件相关内容，例如配置说明和其他一些你在编码时可能需要的功能说明。

惯例说明

本文中的关键词 “必须(MUST)”，“必须不(MUST NOT)”，“需要(REQUIRED)”，“应当(SHALL)”，“不应当(SHALL NOT)”，“应该(SHOULD)”，“不应该(SHOULD NOT)”，“建议(RECOMMENDED)”，“可能(MAY)”，‘可选的(OPTIONAL)’ 意思参见 RFC 2119 [RFC2119]