alexoliverwd/simple-api

A simple REST API framework written in PHP

1.2.2 2025-01-06 19:31 UTC

Requires

• php: >=8.1
• alexoliverwd/brace: ^1.0
• bramus/router: ^1.6
• spatie/url: ^2.2

Requires (Dev)

• guzzlehttp/guzzle: ^7.7
• phpstan/phpstan: ^1.9
• phpunit/phpunit: ^9.5

MIT

• Alex Oliver

• rest
• api

README

A simple REST/CRUD API built using PHP.

Requirements

• PHP version 8.1 or later

Example 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 Result:

{
    "success": [
        "Success"
    ]
}

Error 404

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