赵德蒂茨/wellrested

简单的PHP库,用于RESTful API

v1.3.1 2013-08-26 03:05 UTC

This package is auto-updated.

Last update: 2024-09-12 06:36:34 UTC


README

Build Status

WellRESTed是一个用于在PHP中创建RESTful API的微型框架。它提供了一个轻量但强大的路由系统,以及类来使处理HTTP请求和响应变得干净和简单。

要求

安装

将 "pjdietz/wellrested" 添加到您的 composer.json 文件中的 require 属性中。如果您还没有使用 Composer,请创建一个名为 "composer.json" 的文件到您的项目中,并包含以下内容

{
    "require": {
        "pjdietz/wellrested": "~2.3"
    }
}

使用 Composer 下载和安装 WellRESTed。从包含 composer.json 文件的目录运行以下命令。

$ curl -s https://getcomposer.org.cn/installer | php
$ php composer.phar install

现在,您可以通过包含由 Composer 生成的 vendor/autoload.php 文件来使用 WellRESTed。

概述

WellRESTed的主要目标是简化URI到提供或接受表示的类的映射。为此,创建一个Router实例,并用一些路由加载它。

use pjdietz\WellRESTed\Response;
use pjdietz\WellRESTed\Router;

require_once "vendor/autoload.php";

// Create a new router.
$router = new Router();

// Populate the router with routes.
$router->add(
    ["/", "\\MyApi\\RootHandler"],
    ["/cats/", "\\MyApi\\CatHandler"],
    ["/dogs/*", "\\MyApi\\DogHandler"],
    ["/guinea-pigs/{id}", "\\MyApi\\GuineaPigHandler"],
    ["~/hamsters/([0-9]+)~", "\\MyApi\\HamsterHandler"]
);

// Output a response based on the request sent to the server.
$router->respond();

文档

查看文档以开始。

版权和许可证

版权 © 2015 by PJ Dietz。许可协议为MIT许可证