| title | 搜索，NuGet API |
|---|---|
| description | 搜索服务允许客户端按关键字查询包，并筛选某些包字段的结果。 |
| author | joelverhagen |
| ms.author | jver |
| ms.date | 10/26/2017 |
| ms.topic | reference |
| ms.reviewer | kraigb |
| ms.openlocfilehash | aed591ceba00f1820a573eacf312112db0a1c69e |
| ms.sourcegitcommit | 7e9c0630335ef9ec1e200e2ee9065f702e52a8ec |
| ms.translationtype | MT |
| ms.contentlocale | zh-CN |
| ms.lasthandoff | 06/24/2020 |
| ms.locfileid | 85292264 |
可以使用 V3 API 搜索包源上可用的包。 用于搜索的资源是 SearchQueryService 在服务索引中找到的资源。
使用以下 @type 值：
| @type 值 | 备注 |
|---|---|
| SearchQueryService | 初始版本 |
| SearchQueryService/3.0.0-beta | 别名SearchQueryService |
| SearchQueryService/3.0.0-rc | 别名SearchQueryService |
| SearchQueryService/3.5。0 | 支持 packageType 查询参数 |
此版本引入了对 packageType 查询参数和 packageTypes response 属性的支持，允许按作者定义的包类型进行筛选。 它完全向后兼容的查询 SearchQueryService 。
以下 API 的基 URL 是 @id 与上述某个资源值关联的属性的值 @type 。 在下面的文档中，将使用占位符基 URL {@id} 。
注册资源中找到的所有 Url 都支持 HTTP 方法 GET 和 HEAD 。
搜索 API 允许客户端查询与指定的搜索查询匹配的包页面。 搜索查询（如搜索词的词汇切分）的解释由服务器实现确定，但一般的期望是搜索查询用于匹配包 Id、标题、说明和标记。 还可以考虑其他包元数据字段。
未列出的包决不会出现在搜索结果中。
GET {@id}?q={QUERY}&skip={SKIP}&take={TAKE}&prerelease={PRERELEASE}&semVerLevel={SEMVERLEVEL}&packageType={PACKAGETYPE}
| 名称 | 在 | 类型 | 必需 | 备注 |
|---|---|---|---|---|
| q | 代码 | 字符串 | 否 | 用于筛选包的搜索词 |
| skip | 代码 | integer | 否 | 要跳过的结果数，用于分页 |
| take | 代码 | integer | 否 | 要返回的结果数，用于分页 |
| prerelease | 代码 | boolean | 否 | true或 false 确定是否包括预发布包 |
| semVerLevel | 代码 | 字符串 | 否 | SemVer 1.0.0 版本字符串 |
| packageType | 代码 | 字符串 | 否 | 用于筛选包的包类型（添加到中 SearchQueryService/3.5.0 ） |
搜索查询按 q 服务器实现所定义的方式进行分析。 nuget.org 支持针对各种字段的基本筛选。 如果未 q 提供，则应在 skip 和 take 施加的边界内返回所有包。 这会启用 NuGet Visual Studio 体验中的 "浏览" 选项卡。
skip参数默认为0。
take参数应为大于零的整数。 服务器实现可能会施加最大值。
如果 prerelease 未提供，则将排除预发布包。
semVerLevelQuery 参数用于选择SemVer 2.0.0 包。
如果此查询参数被排除，则将仅返回 SemVer 1.0.0 兼容版本的包（其中包含标准 NuGet 版本控制注意事项，如具有4个整数部分的版本字符串）。
如果 semVerLevel=2.0.0 提供了，则将返回 SemVer 1.0.0 和 SemVer 2.0.0 兼容包。 有关详细信息，请参阅SemVer 2.0.0 support for nuget.org 。
packageType参数用于进一步筛选搜索结果，使其仅包含至少一个与包类型名称匹配的包类型的包。
如果所提供的包类型不是包类型文档定义的有效包类型，将返回一个空结果。
如果提供的包类型为空，则不会应用任何筛选器。 换言之，不将值传递给 packageType 参数的行为就像未传递参数一样。
响应是最多包含搜索结果的 JSON 文档 take 。 搜索结果按包 ID 分组。
根 JSON 对象具有以下属性：
| 名称 | 类型 | 必需 | 备注 |
|---|---|---|---|
| totalHits | integer | 是 | 匹配项的总数，忽略 skip 和take |
| data | 对象数组 | 是 | 请求匹配的搜索结果 |
数组中的每一项 data 都是一个 JSON 对象，其中包含一组共享同一包 ID 的包版本。
该对象包含以下属性：
| 名称 | 类型 | 必需 | 注释 |
|---|---|---|---|
| id | 字符串 | 是 | 匹配包的 ID |
| 版本 | 字符串 | 是 | 包的完整 SemVer 2.0.0 版本字符串（可能包含生成元数据） |
| description | 字符串 | 否 | |
| versions | 对象数组 | 是 | 与参数匹配的包的所有版本 prerelease |
| 作者 | 字符串或字符串数组 | 否 | |
| iconUrl | 字符串 | 否 | |
| licenseUrl | 字符串 | 否 | |
| 所有者 | 字符串或字符串数组 | 否 | |
| projectUrl | 字符串 | 否 | |
| 注册 | 字符串 | 否 | 关联注册索引的绝对 URL |
| 摘要 | 字符串 | 否 | |
| tags | 字符串或字符串数组 | 否 | |
| title | 字符串 | 否 | |
| totalDownloads | integer | 否 | 此值可由数组中的下载内容和 versions |
| 得到 | boolean | 否 | 一个 JSON 布尔值，指示是否验证了包 |
| packageTypes | 对象数组 | 是 | 包作者定义的包类型（已在中添加 SearchQueryService/3.5.0 ） |
在 nuget.org 上，已验证的包是指其包 ID 与保留的 ID 前缀匹配并由保留前缀的一个所有者拥有的包 ID。 有关详细信息，请参阅有关 ID 前缀保留的文档。
搜索结果对象中包含的元数据取自最新的包版本。 数组中的每一项 versions 都是具有以下属性的 JSON 对象：
| 名称 | 类型 | 必需 | 备注 |
|---|---|---|---|
| @id | 字符串 | 是 | 关联注册叶的绝对 URL |
| 版本 | 字符串 | 是 | 包的完整 SemVer 2.0.0 版本字符串（可能包含生成元数据） |
| downloads | integer | 是 | 此特定包版本的下载数 |
packageTypes数组始终包含至少一（1）个项。 给定包 ID 的包类型被认为是由最新版本的包（与其他搜索参数有关）定义的包类型。 数组中的每一项 packageTypes 都是具有以下属性的 JSON 对象：
| 名称 | 类型 | 必需 | 说明 |
|---|---|---|---|
| name | 字符串 | 是 | 包类型的名称。 |
GET https://azuresearch-usnc.nuget.org/query?q=NuGet.Versioning&prerelease=false&semVerLevel=2.0.0
[!code-JSON search-result.json]