restler/application

Luracast Restler 的应用样板,Restler 是一个以 API 为首的微框架

dev-master 2021-06-11 13:50 UTC

This package is auto-updated.

Last update: 2024-09-13 22:54:01 UTC


README

Restler

基本 Restler 应用

Luracast Restler 提供的最小化 API 服务器样板

Restler 是一个以 API 为首的微框架,通过设计提供更好的 Web API。该存储库中的每个分支都包含不同的应用模板,以满足您的需求。

基本应用提供了开始使用 Restler 开发所需的最小功能

安装

确保您的服务器上已安装 PHP 5.5 或更高版本(为了更好的性能,请使用 PHP 的最新版本)

Composer 用于管理依赖项。如果您尚未安装 Composer,我们建议全局安装它

安装 Composer

有关全局安装 Composer 的说明可在 getcomposer.org 中找到

安装基本 Restler 应用

您可以在终端窗口中运行以下命令来安装应用程序

composer create-project restler/application=dev-basic {app_name}

{app_name} 替换为您应用程序的名称。

它将创建一个新的文件夹,并将所有必要的文件放入其中以开始。

或者,由于这是一个模板存储库,您可以直接从其中 生成 您自己的存储库!

里面有什么?

基本是一个用于 API 开发的最小化应用模板。它有一个名为 Home 的示例 API 类,该类为 API 根提供了以下成功消息。

建议为 API 类使用命名空间以避免名称冲突,这里我们使用 App 作为命名空间

{
  "success": {
    "code": 200,
    "message": "Restler is up and running!"
  }
}

在您的开发机器上,您可以通过在项目根目录下运行 composer serve 来运行开发服务器。这将默认在本地主机的 8000 端口上运行 PHP 开发服务器。如果您需要更改此端口,您可以根据需要编辑 composer.json。

此项目还包含 swagger ui,用于测试和记录 API。您可以使用以下 URL 访问它

http://localhost:8000/explorer

下一步

这里只有公开 API,您可能想添加一个身份验证类并添加一些受保护的 API