n3x74/wixy

A complete library for interacting with wiki-api.ir

Maintainers

Details

github.com/N3x74/Wixy

Source

Issues

Installs: 2

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.0 2025-05-19 10:57 UTC

Requires

MIT cda339caab0c2e6c0a32f69662739fc7e339265d

  • N3x74 <4.ho3ein.woop@gmail.com>

This package is auto-updated.

Last update: 2025-06-19 11:11:09 UTC

README

License Packagist

Wixy is a lightweight PHP SDK for communicating with the Nest API.
It supports versioned API endpoints, built-in error handling, and clean abstraction for your HTTP requests.

🚀 Features

  • Simple and clean interface
  • Version-based API routing
  • Error-safe JSON decoding
  • Guzzle-powered HTTP client
  • Composer & Git installation support

📦 Installation

Option 1: Install via Composer

composer require n3x74/wixy

Make sure Composer is installed: https://getcomposer.org

Option 2: Clone via Git

git clone https://github.com/N3x74/Wixy.git

Then include it manually or use PSR-4 autoloading.

🛠 Usage

require 'vendor/autoload.php'; // if using Composer

use N3x74\Wixy\Api;

$api = new Api('your_api_key_here');

$response = $api
    ->version(1) // api version
    ->get('endpoint-name', [
        'param1' => 'value1',
        'param2' => 'value2',
    ]);

print_r($response);

📘 Example

$response = $api->version(1)->get('ChatGPT', ['q' => 'Hello']);

if ($response['status_code'] === 200) {
    $data = $response['body'];
    echo "Result: " . $data['detail']['data'] ?? 'No result';
} else {
    echo "Error: " . $response['error'];
}

📥 Response Format

✅ On success:

[
    'status_code' => 200,
    'body' => [ ...parsed JSON response... ]
]

❌ On failure:

If the error response is JSON:

[
    'status_code' => 400,
    'body' => [ ...parsed JSON error... ],
    'error' => 'Guzzle exception message'
]

If the error is plain text:

[
    'status_code' => 500,
    'body' => 'Server Error',
    'error' => 'Guzzle exception message'
]

📚 API Versioning

To target a specific API version:

$api->version(1)->get('endpoint');
$api->version(2)->get('another-endpoint');

Internally, the version changes the request path to:

https://open.wiki-api.ir/apis-{version}/{endpoint}

✅ Requirements

  • PHP 8.0 or higher
  • GuzzleHTTP 7+

📄 License

This project is open-sourced under the MIT license.

🔗 Links