0

我目前正在使用这个 API 开始一个项目,guitarparty。问题是我不知道如何使用它。

例如,这条线

curl -H 'Guitarparty-Api-Key: {API_KEY}' http://api.guitarparty.com/v2/songbooks/

我什至不知道我应该把它放在哪里。有人可以举例说明如何使用它吗?就像,只是为了请求一首歌。

API 看起来非常简单。问题是我不知道如何开始。谢谢。

api 文档很短,但我不明白从哪里开始。

http://www.guitarparty.com/developers/api-docs/api-resources/songs/#available-song-methods

4

1 回答 1

1

curl 是一个用于处理 HTTP 和类似协议的命令行工具。你可以在这里下载: http ://curl.haxx.se

该行旨在输入到安装了 curl 的系统上的命令行中,可能是在类似 Linux 的系统上。您可能想要下载 curl 并尝试按照示例进行操作。

然而,像这样的 API 的美妙之处在于您不需要使用任何特定的工具——您可以使用任何您想要的工具,只要您可以设置 HTTP 标头值。许多不同的工具和模块可以发出 HTTP 请求。

您必须做的第一件事是在 GuitarParty 站点获取 API 密钥。这是一个可以识别您的应用程序的键,并且可能会对您可以运行的查询数量等施加一些限制。没有一个,您将无法使用 API。您打算将上面的“{API_KEY}”替换为实际的 API 密钥。

查询示例(来自文档)是:

curl -H 'Guitarparty-Api-Key: {API_KEY}' http://api.guitarparty.com/v2/songs/?query=Jolene

这里发生的是 curl 被用于通过 HTTP 发出正常的 GET 请求。当您单击链接时,浏览器通常会向您发出这种请求。URL 是“ http://api.guitarparty.com/v2/songs/?query=Jolene ”——这是你要修改的搜索“Jolene”以外的歌曲。发生的唯一奇怪的事情是自定义 HTTP 标头值被设置:“Guitarparty-Api-Key”,API 密钥。-H 是用于设置自定义标头的 curl 语法。

作为响应,您将从服务器返回一个带有搜索结果的 JSON 编码结构。您将需要解析此结构并提取您感兴趣的部分。

对于任何类型的细节——如何使用特殊标头发出 HTTP 请求,如何解析 JSON——我必须知道你打算使用哪种语言或环境。例如,对于 Python ,我建议您查看模块“urllib2”和“json”。

于 2013-03-15T22:33:16.527 回答