金融科技系统/虚拟Min API

一个设计为独立运行或作为Laravel应用程序一部分的虚拟Min API

1.0.0 2021-09-01 19:16 UTC

This package is auto-updated.

Last update: 2024-09-14 15:52:59 UTC


README

GitHub release (latest by date) Build Status GitHub

一个设计为独立运行或作为Laravel应用程序一部分的虚拟Min API

需求

  • PHP 8.0
  • 一个正在运行的虚拟Min服务器,使用远程API

功能

  • 列出域名(虚拟Min输出)
  • 获取域名(用户友好的输出)
  • 更改计划
  • 列出计划(虚拟Min输出)
  • 获取计划(用户友好的输出)
  • 创建域名

获取域名

框架无关的PHP

use \FintechSystems\VirtualminApi\VirtualminApi;
$api = new VirtualminApi(
        'hostname' => 'virtualmin.test',
        'username' => 'root',
        'password' => '********'
    );
$api->getDomains();

Laravel应用程序

VirtualminApi::getDomains();

输出

虚拟Min服务器上所有域名的数组。

更改计划

框架无关的PHP

use \FintechSystems\VirtualminApi\VirtualminApi;
$api = new VirtualminApi;
$api->changePlan('example.com', 'New Plan Name');

Laravel应用程序

VirtualminApi::changePlan('example.com', 'New Plan Name');

创建域名

示例

$api->createDomain([
    // New virtual server details
    'domain'                 => 'demo.example.com',
    'desc'                   => 'My demo website',
    'pass'                   => '***************',
    'template'               => 'WikiSuite 1',
    'plan'                   => 'WikiSuite 1',
    
    // Advanced options
    'email'                  => 'contact@example.com',
    'db'                     => 'demo_example_com',
    
    // Enabled features
    'features-from-plan'     => '',
    'virtualmin-tikimanager' => ''
]))

测试

我们有测试!请使用以下命令运行测试。

否则将进行实时API调用,这会导致您的测试失败。

vendor/bin/phpunit --exclude-group=live

覆盖率报告

要重新生成覆盖率报告

XDEBUG_MODE=coverage ./vendor/bin/phpunit --coverage-html=tests/coverage-report

另请参阅 .travis.yml

变更日志

请参阅变更日志以获取有关最近更改的更多信息。

版本控制

此应用程序使用语义版本控制

https://semver.org/

本地编辑

对于本地编辑,请将以下内容添加到 composer.json

"repositories" : [
        {
            "type": "path",
            "url": "../virtualmin-api"
        }
    ]

致谢

灵感

这个独立包受到了Marcel Pociot的BeyondCode视频课程的启发
PHP包开发

在我做视频课程之前,我已经开发了多个版本的同类型东西,但它从未是独立的,因此随着时间的推移,维护变得困难,而且在新的项目中快速使用也变得困难。

如何贡献

请通过GitHub添加问题和合并请求。

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件