README

关于

Designer News API 的简单 PHP 封装。

要求

PHP 5.3.x 或更高版本
cURL
有效的 Designer News 访问令牌

OAuth 2

此库假设您已经使用您首选的 OAuth 库获取了有效的访问令牌。

请注意，截至本文撰写时，Designer News API 仅支持 ClientCredentials 和 Password Grant 类型。

入门指南

您可以从存储库中下载最新版本，或者作为依赖项使用 Composer 安装。

使用 Composer 安装

{
    "require": {
        "ghosh/designernews-php-api": "~1.0"
    }
}

然后，从您的应用程序根目录的命令行中运行 composer.phar install。

实例化类

$config = array(
	"accessToken"  => "YOUR_ACCESS_TOKEN"
);

try
{
	$DN = new DesignerNews($config);
}
catch (Exception $e)
{
	echo $e->getMessage();
}

这创建了一个新的 Designer News API 类实例，并将其分配给 $DN 处理器。建议将其包装在 try/catch 块中，以处理可能出现的任何错误。

配置选项

accessToken 必需 - 这是 OAuth 库提供给您的访问令牌
apiVersionSegment 可选 - 当前 API 版本。默认为 v1
userAgent 可选 - 应用程序的用户代理。Designer News 建议将其设置为您的电子邮件地址，以便在检测到任何数据滥用时与您联系。默认为 designer-news-api-php-wrapper

可用方法

包装器包括用于代表认证用户执行 HTTP 请求的方便方法。以下列出了所有可用方法。

用户

$DN->me();

故事

$DN->getStory($id);
$DN->upvoteStory($id);
$DN->commentOnStory($id, $comment);
$DN->getTopStories();
$DN->getRecentStories();
$DN->searchForStory($queryString);

$DN->getComment($id);
$DN->upvoteComment($id);
$DN->replyToComment($id, $reply);

MOTD (每日消息)

$DN->getMOTD();
$DN->upvoteMOTD();
$DN->downvoteMOTD();

响应类型

Designer News API PHP 包装器返回的所有响应都作为 PHP 对象。

反馈和错误

如果您遇到任何错误或希望添加的功能，请随时在此 github 上打开一个新的问题。最欢迎拉取请求。

ghosh / designernews-php-api

维护者

详细信息