クライアントは、特定のパッケージの README をダウンロードするために使用できる URL を構築できます。 これにより、クライアントはパッケージ全体をダウンロードせずにパッケージの README をレンダリングできます。
この URL の構築に使用されるリソースは、サービス インデックスで見つかった ReadmeUriTemplate リソースです。
バージョン管理
次の @type 値が使用されます。
| @type 値 | 筆記 |
|---|---|
| ReadmeUriTemplate/6.13.0 | 最初のリリース |
URL テンプレート
次の API の URL は、前述のリソース @type 値のいずれかに関連付けられている @id プロパティの値です。
HTTP メソッド
構築された URL は、HTTP メソッド GET をサポートする必要があります
URL を構築する
既知のパッケージ ID とバージョンを指定すると、クライアント実装は README をダウンロードするための URL を構築できます。
@id の値は、次のいずれかのプレースホルダー トークンを含む URL 文字列です。
URL プレースホルダー
| 名前 | 種類 | 必須 | 筆記 |
|---|---|---|---|
{lower_id} |
糸 | はい | パッケージ ID (小文字) |
{lower_version} |
糸 | はい | パッケージのバージョン (小文字) |
lower_id と lower_version の両方が、によって実装される規則を使用して小文字になります。NET の
System.String.ToLowerInvariant() メソッド。
lower_version は、NuGet のバージョン 正規化ルールを使用して正規化された目的のパッケージ バージョンです。 つまり、この場合、SemVer 2.0.0 仕様で許可されているビルド メタデータを除外する必要があります。
応答本文
パッケージに readme がある場合は、200 状態コードが返されます。 応答本文は readme コンテンツ自体になります。
パッケージに readme がない場合は、404 状態コードが返されます。