包详细信息 URL 模板
客户端可生成可由用户用于在其 Web 浏览器中查看更多包详细信息的 URL。 当包源想显示可能与 NuGet 客户端应用程序所显示范围不相符的包的其他信息时,此功能非常有用。
用于生成此 URL 的资源是在服务索引中找到的 PackageDetailsUriTemplate
资源。
版本控制
使用了以下 @type
值:
值@type | 说明 |
---|---|
PackageDetailsUriTemplate/5.1.0 | 初始版本 |
URL 模板
以下 API 的 URL 是与其中一个上述资源 @type
值关联的 @id
属性的值。
HTTP 方法
尽管客户端不打算代表用户向包详细信息 URL 发出请求,但网页应支持 GET
方法,从而允许在 Web 浏览器中轻松打开已单击的 URL。
构造 URL
由于存在已知的包 ID 和版本,客户端实现可构造用于访问 Web 接口的 URL。 客户端实现应向用户显示此构造的 URL(或可单击链接),以便他们能打开指向该 URL 的 Web 浏览器并了解有关包的详细信息。 包详细信息页面的内容由服务器实现确定。
该 URL 必须为绝对 URL,而方案(协议)则必须为 HTTPS。
服务索引中 @id
的值是包含以下任意占位符标记的 URL 字符串:
URL 占位符
名称 | 类型 | 必须 | 注释 |
---|---|---|---|
{id} |
string | 否 | 要获取其详细信息的包 ID |
{version} |
string | 否 | 要获取其详细信息的包版本 |
服务器应接受采用任意大小写形式的 {id}
和 {version}
值。 此外,服务器不应区分版本是否已规范化。 换言之,服务器还应接受非规范化版本。
例如,nuget.org 的包详细信息模板如下所示:
https://www.nuget.org/packages/{id}/{version}
如果客户端实现需显示 NuGet.Versioning 4.3.0 包详细信息的链接,它则会生成以下 URL 并将其提供给用户:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0