客户端可以生成可用于下载特定包的自述文件 URL。 这将使客户端能够在不下载整个包的情况下呈现包的自述文件。
用于生成此 URL 的资源是在 服务索引中找到的 ReadmeUriTemplate 资源。
版本控制
使用以下 @type 值:
| @type 值 | 笔记 |
|---|---|
| ReadmeUriTemplate/6.13.0 | 初始版本 |
URL 模板
以下 API 的 URL 是与上述资源 @type 值之一关联的 @id 属性的值。
HTTP 方法
构造的 URL 必须支持 HTTP 方法 GET
构造 URL
给定已知的包 ID 和版本,客户端实现可以构造 URL 来下载自述文件。
@id 的值是包含以下任何占位符标记的 URL 字符串:
URL 占位符
| 名字 | 类型 | 必填 | 笔记 |
|---|---|---|---|
{lower_id} |
字符串 | 是的 | 包 ID(小写) |
{lower_version} |
字符串 | 是的 | 包版本,小写 |
lower_id 和 lower_version 均使用由其实现的规则小写。NET 的
System.String.ToLowerInvariant() 方法。
lower_version 是使用 NuGet 的版本 规范化规则规范化所需的包版本。 这意味着必须排除 SemVer 2.0.0 规范允许的生成元数据。
响应正文
如果包有自述文件,则返回 200 状态代码。 响应正文将是自述文件内容本身。
如果包没有自述文件,则返回 404 状态代码。