URL-Vorlage für Paketdetails
Es ist möglich, dass ein Client eine URL erstellt, die vom Benutzer verwendet werden kann, um weitere Paketdetails in ihrem Webbrowser anzuzeigen. Dies ist nützlich, wenn eine Paketquelle zusätzliche Informationen zu einem Paket anzeigen möchte, die möglicherweise nicht in den Bereich der Darstellung der NuGet-Clientanwendung passen.
Die Zum Erstellen dieser URL verwendete Ressource ist die PackageDetailsUriTemplate Ressource im Dienstindex.
Versionsverwaltung
Die folgenden @type-Werte werden verwendet:
| Wert vom Typ @type | Hinweise |
|---|---|
| PackageDetailsUriTemplate/5.1.0 | Erstrelease |
URL-Vorlage
Die Basis-URL für die folgenden APIs ist der Wert der @id-Eigenschaft, die einem der oben genannten @type-Ressourcenwerte zugeordnet ist.
HTTP-Methoden
Obwohl der Client nicht beabsichtigt ist, Anforderungen an die PAKETdetails-URL im Namen des Benutzers zu senden, sollte die Webseite die GET-Methode unterstützen, damit eine geklickte URL in einem Webbrowser leicht geöffnet werden kann.
Erstellen der URL
Angesichts einer bekannten Paket-ID und -Version kann die Clientimplementierung eine URL erstellen, die für den Zugriff auf eine Webschnittstelle verwendet wird. Die Clientimplementierung sollte diese konstruierte URL (oder klickbare Verknüpfung) für den Benutzer anzeigen, sodass er einen Webbrowser mit der URL öffnen und mehr über das Paket erfahren kann. Der Inhalt der Seite mit den Paketdetails wird durch die Serverimplementierung bestimmt.
Die URL muss eine absolute URL sein, und das Schema (Protokoll) muss HTTPS sein.
Der Wert von @id im Dienstindex ist eine URL-Zeichenfolge, die eines der folgenden Platzhalter-Tokens enthält:
Sie verwenden URL-Platzhalter
| Name | Type | Erforderlich | Notizen |
|---|---|---|---|
{id} |
Zeichenfolge | Nein | Die Paket-ID zum Abrufen von Details für |
{version} |
Zeichenfolge | Nein | Die Paketversion zum Abrufen von Details für |
Der Server sollte die Werte {id} und {version} in beliebiger Form akzeptieren. Darüber hinaus sollte der Server nicht darauf achten, ob die Version normalisiert ist. Mit anderen Worten, der Server sollte auch nicht normalisierte Versionen akzeptieren.
Beispielsweise sieht die Paketdetailsvorlage von nuget.org wie folgt aus:
https://www.nuget.org/packages/{id}/{version}
Wenn die Clientimplementierung einen Link zu den Paketdetails für NuGet.Versioning 4.3.0 anzeigen muss, wird die folgende URL erstellt und dem Benutzer bereitgestellt:
https://www.nuget.org/packages/NuGet.Versioning/4.3.0