自述檔 URI 範本
用戶端可以建置 URL,以便用來下載特定套件的自述檔。 這可讓用戶端在不下載整個套件的情況下轉譯套件的自述檔。
用來建置此網址的資源是在 服務索引中找到的 ReadmeUriTemplate
資源,。
版本控制
使用下列 @type
值:
@type 值 | 筆記 |
---|---|
ReadmeUriTemplate/6.13.0 | 初始版本 |
URL 範本
下列 API 的 URL 是與上述其中一個資源 @type
值相關聯的 @id
屬性值。
HTTP 方法
建構的 URL 必須支援 HTTP 方法 GET
建構 URL
假設有已知的套件標識碼和版本,用戶端實作可以建構 URL 以下載自述檔。
@id
的值是 URL 字串,其中包含下列任何佔位元令牌:
URL 佔位元
名字 | 類型 | 必填 | 筆記 |
---|---|---|---|
{lower_id} |
字串 | 是的 | 封裝標識碼,小寫 |
{lower_version} |
字串 | 是的 | 套件版本,小寫 |
lower_id
和 lower_version
都是使用 所實作的規則小寫。NET 的
System.String.ToLowerInvariant()
方法。
lower_version
是所需的套件版本,使用 NuGet 的版本 正規化規則。 這表示必須排除 SemVer 2.0.0 規格所允許的建置元數據。
回應本文
如果套件有自述檔,則會傳回 200 狀態代碼。 回應本文會是自述文件內容本身。
如果套件沒有自述檔,則會傳回 404 狀態代碼。