README

VocaDB API PHP 客户端

注意：这是一个早期 alpha 版本，仍在开发中！

安装

使用 composer（推荐）

只需运行： composer require pbxg33k/vocadb dev-master

或将以下行添加到 composer.json 中的 require 部分："pbxg33k/vocadb":"dev-master"

不使用 composer

下载此存储库的 zip 文件。
解压缩到您的应用程序目录中
将文件添加到您的项目中
- 如果您的自动加载器支持 PSR-4，请将 "pbxg33k/vocadb" 映射到此目录
- 如果您的项目中没有自动加载器或自动加载器不支持 PSR-4，请包含 autoload.php

如何使用

本项目目标是轻松集成 VocaDB 的公共 API。

在您进行任何操作之前，必须加载客户端

	$client = new Pbxg33k\VocaDB\Client();

客户端使用 Guzzle 与 API 进行通信。您可以将任何 guzzle 配置传递给以 'guzzle' 为键的数组。

例如，假设您的服务器位于代理后面，无法直接与 VocaDB 的 API 通信。我们可以指导 Guzzle 使用代理进行通信，只需将代理信息添加到构造函数中。

	$guzzleConfig = [
		'request.options' => [
			'proxy' => 'tcp://:80/'
		]
	];
	
	// We assign the $guzzleConfig to array('guzzle' => data) so we don't mix up the library's own config.
	$clientConfig = ['guzzle' => $guzzleConfig];

	$client = new Pbxg33k\VocaDB\Client($clientConfig);

从现在开始，您可以通过调用客户端的方法与 API 进行通信。

	// Get Livetune's information
	$livetune = $client->artist->getByName('livetune');

	// $livetune is now an array with searchresults

待办事项

添加所有缺失的端点
- 部分完成 歌曲
- 条目
- 歌曲列表
- 部分完成 专辑
- 用户
- 部分完成 标签
- 部分完成 艺术家
- 部分完成 发布事件
- 讨论

pbxg33k / vocadb

维护者

详细信息