推送符号包

可使用 NuGet V3 API 推送符号包 (snupkg)。 这些操作均基于在服务索引中找到的 SymbolPackagePublish 资源。

版本控制

使用以下 @type 值:

值@type 说明
SymbolPackagePublish/4.9.0 初始版本

基 URL

以下 API 的基 URL 是包源的服务索引SymbolPackagePublish/4.9.0 资源的 @id 属性值。 对于以下文档,将使用 nuget.org 的 URL。 请考虑将 https://www.nuget.org/api/v2/symbolpackage 用作在服务索引中找到的 @id 值的占位符。

HTTP 方法

此资源支持 PUT HTTP 方法。

推送符号包

nuget.org 支持使用以下 API 推送新的符号包格式 (snupkg)。

PUT https://www.nuget.org/api/v2/symbolpackage

可多次提交具有相同 ID 和版本的符号包。 出现以下情况时,将拒绝符号包。

  • 具有相同 ID 和版本的包不存在。
  • 已推送具有相同 ID 和版本的符号包,但尚未发布。
  • 符号包 (snupkg) 无效(请参阅符号包约束)。

请求参数

名称 类型 必须 说明
X-NuGet-ApiKey 头文件 string 例如: X-NuGet-ApiKey: {USER_API_KEY}

API 密钥是用户从包源获取并配置到客户端中的不透明字符串。 不会强制使用特定字符串格式,但 API 密钥的长度不应超过 HTTP 标头值的合理大小。

请求正文

符号推送的请求正文与包推送请求的请求正文相同(请参阅包推送和删除)。

响应

状态代码 含义
201 已成功推送符号包。
400 提供的符号包无效。
401 用户无权执行此操作。
404 具有所提供 ID 和版本的相应包不存在。
409 已推送具有所提供 ID 和版本的符号包,但尚不可用。
413 包过大。