deviantART SDK

deviantART SDK 是一个库，它使得开发人员可以更容易地使用 deviantART API 创建和开发应用程序。它目前支持 deviantART API 上的所有公开 OAuth2 API 方法，并提供简单的身份验证方法。使用此 SDK 应该可以简化任何希望将其添加到其应用程序中的开发人员的 deviantART 集成。

如何开始

• 下载 SDK 并尝试附带的示例 iOS 应用或示例 Mac 应用。
• 查看并阅读包含的代码文档，以深入了解您可以使用的内容。
• 有问题？提出一个问题！

Podfile

platform :ios, '7.0'
pod "deviantART-SDK", "~> 1.0.1"

设置

为了设置，将此行添加到您的应用程序代理的 application:didFinishLaunchingWithOptions: 方法中，以便在 SDK 全局范围内设置您的客户端 ID 和密钥

[DVNTAPIClient setClientID:@"__CHANGE_ME__" clientSecret:@"__CHANGE_ME__"];

在此处注册您的应用程序 http://www.deviantart.com/developers/register 以获取客户端 ID 和密钥。

SDK 默认使用 https://www.deviantart.com/oauth2/redirect 作为重定向 URI，您可以通过直接在设置客户端 ID 和密钥后在 DVNTAPIClient 上调用 setRedirectURI: 来更改此设置。

通过 deviantART 进行身份验证

通过 SDK 实现以下方法进行 deviantART 身份验证

[DVNTAPIClient authenticateFromController:self scope:@"basic" completionHandler:^(NSError *error) {

    if(!error && [DVNTAPIClient isAuthenticated]) {
        // App is fully authenticated with no errors 
        // and ready to perform API calls
    } else {
        NSLog(@"Error: %@", error);
    }
}];

此方法将根据平台显示一个视图控制器或窗口，作为必要的 OAuth2 表格。当在此控制器/窗口中完成登录时，将调用 completionHandler。

用法

DVNTAPIClient

DVNTAPIClient 封装 OAuth2 身份验证和客户端逻辑。它还提供了执行 GET/POST 调用的基本方法。这些 GET/POST 方法由 DVNTAPIRequest 包装，以为您提供更佳的 API。无论何时需要 DVNTAPIRequest 已有的 API 调用，都应使用此方法。如果 DVNTAPIRequest 的方法中缺少 API 调用，请提出问题或发送 pull 请求以添加它。

GET 请求

GET 调用以获取文件夹的元数据。

[DVNTAPIClient GET:@"/api/oauth2/stash/metadata" parameters:@{@"folderid": @"12345"} success:^(NSURLSessionDataTask *task, id JSON) {

    NSLog(@"Your folder's title is %@", JSON[@"title"]);               
} failure:^(NSURLSessionDataTask *task, NSError *error) { 

    NSLog(@"Error: %@", error);
}];

POST 请求

POST 调用以删除 Sta.sh 项目。

[DVNTAPIClient POST:@"/api/oauth2/stash/delete" parameters:@{@"stashid": @"12345"} success:^(NSURLSessionDataTask *task, id JSON) {

    NSLog(@"Your deleted StashID was %@”, JSON[@"stashid"]);               
} failure:^(NSURLSessionDataTask *task, NSError *error) { 

    NSLog(@"Error: %@", error);
}];

DVNTAPIRequest

该类为以下列表中 DeviantART API 的每个端点提供包装。关于这些调用执行详细信息的深入介绍，请参阅 deviantART 上的 开发者 页面。

• user/whoami
• user/whois
• stash/submit
• stash/delete
• stash/move/folder
• stash/move/file
• stash/folder
• stash/space
• stash/delta
• stash/metadata
• stash/media
• oEmbed

有关 DVNTAPIRequest 中的方法更多信息，请查看类的头文件或以下文档。

文档

DVNTAPIRequest 和 DVNTAPIClient 的完整文档将在 Pod 安装时会安装到 Xcode 的文档工具中。在“帮助 -> 文档和 API 参考”下打开文档查看器，然后选择“deviantART SDK 文档”。

问题和拉取请求

问题

请确保开启的所有问题都有清晰简洁的信息。对于错误，如果可能的话，请包括复现步骤，这将使更正问题变得更加简单。对于其他一般性问题，请尽可能提供信息，以便我们清楚地了解您遇到的问题。

拉取请求

任何拉取请求都必须遵守 deviantART 的 Objective-C 代码风格指南。这确保了代码库对于可能参与项目的任何开发人员都是一致和清晰的。

您的拉取请求应理想地提供为什么需要更改的信息，无论是通过链接到当前问题还是通过清楚地解释您的更改及其结果。这样我们可以快速管理您的拉取请求，并在需要时合并更改。