查询字段
这些是架构中的顶级查询字段。
me (帐户)
由 Authorization
标头中使用的访问令牌标识的帐户。
release (版本)
由 version
参数指定的版本的元数据。
参数 | 类型 | 描述 |
---|---|---|
version | String! | 必需。必须为 major.minor.patch 版本号,例如“6.0.0”。“latest” 将解析为 5.x 的最新完整版本,但在 6.0 版中已弃用。 |
releases ([版本])
所有可用版本列表。
search ([图标])
图标查询的结果,使用与为 图标库 提供支持的相同的 Algolia 搜索引擎。
如果此字段解析为 null
,则表示在执行搜索时出现问题,例如尝试在不存在的 Font Awesome 版本上搜索。返回的 errors
可能包含其他信息。
参数 | 类型 | 描述 |
---|---|---|
version | String! | 必需。必须为 major.minor.patch 版本号,例如“5.12.0”。“latest” 将解析为 5.x 的最新完整版本,但在 6.0 版中已弃用。 |
query | String! | 必需。搜索词的字符串,例如“coff”或“coffee mug”。 |
first | Integer | 默认值:15。将结果限制为此数量:前“X”个结果。 |
示例
这将返回与 6.0.0 版中查询“coff”匹配的前五个结果。
search(version: "6.0.0", query: "coff", first: 5) { id }
{ "data": { "search": [ { "id": "coffin-cross" }, { "id": "coffin" }, { "id": "coffee-togo" }, { "id": "coffee-pot" }, { "id": "coffee" } ] }}
模糊搜索 vs. 按名称查找图标
search
字段用于模糊搜索。它不仅仅将搜索词与图标名称匹配。这对帮助用户根据概念或词语关联发现图标非常有用。如果记不住图标的准确名称,这也很有帮助:足够接近可能就足够了!
例如,搜索“coffee”可能有助于您发现除了熟悉的 mug-saucer
图标之外,还有其他与咖啡相关的图标——顺便说一句,它不再被称为“coffee”!搜索“coffee”还会找到咖啡豆、咖啡壶、外带咖啡杯等等。
但是,如果您想按名称查找特定图标,则不能保证它会作为第一个搜索结果出现,即使您按其确切名称搜索也是如此。因此,如果您想 按名称选择特定图标,请使用 release
下的 icon
字段,而不是 search
。