【问题标题】:Don't understand how to use this api不明白如何使用这个api
【发布时间】:2013-03-04 18:45:24
【问题描述】:

我目前正在使用这个 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

【问题讨论】:

  • 祈祷有 API 文档,并阅读它们。 httpie 是命令行 HTTP 请求的朋友。

标签: json api request


【解决方案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”。

【讨论】:

猜你喜欢
  • 2017-08-13
  • 2022-12-16
  • 2012-01-30
  • 1970-01-01
  • 1970-01-01
  • 2016-08-12
  • 2020-04-26
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多