alexoliverwd/simple-api

使用 PHP 编写的简单 REST API 框架

维护者

详细信息

github.com/aoliverwd/simple-api

源代码

问题

安装次数: 306

依赖者: 0

建议者: 0

安全性: 0

星星: 0

关注者: 1

分支: 0

开放问题: 0

v1.2.1 2023-12-27 23:08 UTC

Requires

Requires (Dev)

MIT a6dc525b5ffc15b895cfc1dff5dea28f08ca4b9e

restapi

This package is auto-updated.

Last update: 2024-09-07 17:44:30 UTC

README

使用 PHP 构建的简单 REST/CRUD API。

要求

  • PHP 版本 8.1 或更高

示例 index.php

<?php

namespace APIExample;

use AOWD\SimpleAPI\Methods;
use AOWD\SimpleAPI\Status;
use AOWD\SimpleAPI\API;

// Load dependencies
require_once dirname(__DIR__) . '/vendor/autoload.php';

// Register API modules loaded action
API::registerAction('modules_loaded', '\APIExample\registerRoutes');

/**
 * Register API routes
 * @return void
 */
function registerRoutes(): void
{
    // Register index page GET request
    API::registerRoute(Methods::GET, '/api/', '\APIExample\home');
}

/**
 * Process API home endpoint
 * @return never
 */
function home(): never
{
    API::sendMessage(
        messages: ['Success'],
        status: Status::Success,
        response_code: 200
    );
}

// Run API
API::init();

200 成功结果

{
    "success": [
        "Success"
    ]
}

错误 404

{
    "fail": [
        "Route not found"
    ]
}