搜索 API 版本 1

我将用一些好消息来打破围绕Specs Repo 更改的厄运和阴霾。我们已经开放了我们的搜索 API 的 v1！

这是在 CocoaPods.org 中使用的 API，并且很快将在 CocoaDocs 中使用。继续阅读以了解如何在您自己的应用程序中使用它，我非常期待看到人们用它做了什么。

API 描述

Pods 端点

http://search.cocoapods.org/api/pods

查询字符串参数

query:    The query string.
amount:   The number of results requested [Default: 20].
start-at: The offset in the set of results [Default: 0].

示例

http://search.cocoapods.org/api/pods?query=test&amount=100&start-at=50

我使用哪个查询字符串？

您使用的query字符串是您在 CocoaPods.org 上的搜索引擎中输入的内容。此外，您可以通过使用on:ios、on:osx或on:ios on:osx为查询字符串添加前缀来过滤其中一个或两个平台（我们将其隐藏在四个单选按钮后面）。

例如，如果您只想查看在 iOS 上运行的“测试”pod，则使用on:ios为查询字符串添加前缀

curl 'http://search.cocoapods.org/api/pods?query=on:ios%20test'

格式

我们返回 4 种不同的格式，全部采用 JSON

  1. Picky 风格结果，其中 pod 数据为哈希。
  2. Picky 风格结果，其中 pod 名称为字符串。
  3. 结果的平面列表，其中 pod 数据为哈希。
  4. 结果的平面列表，其中 pod 名称为字符串。

您需要通过 Accept 标头提供所需的格式。上述 4 个选项转换为

Accept: application/vnd.cocoapods.org+picky.hash.json; version=1
Accept: application/vnd.cocoapods.org+picky.ids.json; version=1
Accept: application/vnd.cocoapods.org+flat.hash.json; version=1
Accept: application/vnd.cocoapods.org+flat.ids.json; version=1

默认值

您不必提供所有详细信息。例如，不提供版本将返回最新版本。我们建议您始终提供版本。

请参阅所有规范的列表。所有这些参数都将返回结果。

默认格式是 Picky 风格结果，其中 pod 信息为哈希。

示例

格式

curl 'http://search.cocoapods.org/api/pods?query=name:kiwi' \
  -H "Accept: application/vnd.cocoapods.org+picky.hash.json; version=1"

curl 'http://search.cocoapods.org/api/pods?query=name:kiwi' \
  -H "Accept: application/vnd.cocoapods.org+picky.ids.json; version=1"

curl 'http://search.cocoapods.org/api/pods?query=name:kiwi' \
  -H "Accept: application/vnd.cocoapods.org+flat.hash.json; version=1"

curl 'http://search.cocoapods.org/api/pods?query=name:kiwi' \
  -H "Accept: application/vnd.cocoapods.org+flat.ids.json; version=1"

查询参数

curl 'http://search.cocoapods.org/api/pods?query=name:test' \
  -H "Accept: application/vnd.cocoapods.org+flat.ids.json"

curl 'http://search.cocoapods.org/api/pods?query=name:test&start-at=3' \
  -H "Accept: application/vnd.cocoapods.org+flat.ids.json"

curl 'http://search.cocoapods.org/api/pods?query=s&amount=1000' \
  -H "Accept: application/vnd.cocoapods.org+flat.ids.json"

便捷端点

在命令行上使用 curl 并输入 Accept 标头并不总是方便的。因此，我们还提供了 4 个其他端点，以便在浏览器中快速查看结果。

http://search.cocoapods.org/api/v1/pods.picky.hash.json?query=test
http://search.cocoapods.org/api/v1/pods.picky.ids.json?query=test
http://search.cocoapods.org/api/v1/pods.flat.hash.json?query=test
http://search.cocoapods.org/api/v1/pods.flat.ids.json?query=test

注意事项

随着我们改进搜索引擎，它可能会时不时地宕机半分钟。请在任何用户界面中允许这种情况发生。

尽情享受 - 我们很好奇你们想出了什么！就我个人而言，我非常想要一个 CocoaPod，它可以解析Picky 风格结果并将其提供给其他应用程序 <3