套件詳細數據 URL 範本
用戶端可以建置 URL,讓使用者可以在網頁瀏覽器中查看更多套件詳細數據。 當套件來源想要顯示可能不符合 NuGet 用戶端應用程式所顯示範圍之套件的其他資訊時,這會很有用。
用來建置此 URL 的資源是PackageDetailsUriTemplate
服務索引中找到的資源。
版本控制
使用下列 @type
值:
@type 值 | 備註 |
---|---|
PackageDetailsUriTemplate/5.1.0 | 初始版本 |
URL 範本
下列 API 的 URL 是 @id
與上述其中一個資源 @type
值相關聯的 屬性值。
HTTP 方法
雖然用戶端不打算代表使用者向套件詳細數據 URL 提出要求,但網頁應該支援 GET
方法,以允許在網頁瀏覽器中輕鬆開啟點擊的 URL。
建構 URL
假設有已知的套件標識碼和版本,用戶端實作可以建構用來存取 Web 介面的 URL。 用戶端實作應該向用戶顯示這個建構的 URL(或可點選連結),讓他們能夠開啟網頁瀏覽器至 URL,並深入瞭解套件。 套件詳細數據頁面的內容取決於伺服器實作。
URL 必須是絕對 URL,配置(通訊協定)必須是 HTTPS。
服務索引中的 值 @id
是 URL 字串,其中包含下列任何佔位元令牌:
URL 佔位元
名稱 | 類型 | 必要 | 備註 |
---|---|---|---|
{id} |
string | 否 | 要取得詳細數據的套件識別碼 |
{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