Modello URI README
È possibile che un client crei un URL che può essere usato per scaricare un file README per un pacchetto specifico. In questo modo i client eseguiranno il rendering del file README del pacchetto senza scaricare l'intero pacchetto.
La risorsa usata per la compilazione di questo URL è la risorsa ReadmeUriTemplate disponibile nell'indice del servizio .
Controllo delle versioni
Vengono usati i valori di @type seguenti:
| valore @type | Note |
|---|---|
| ReadmeUriTemplate/6.13.0 | Versione iniziale |
Modello di URL
L'URL per l'API seguente è il valore della proprietà @id associata a uno dei valori @type della risorsa menzionati in precedenza.
Metodi HTTP
L'URL costruito deve supportare il metodo HTTP GET
Costruire l'URL
Dato un ID e una versione noti del pacchetto, l'implementazione client può costruire un URL per scaricare il file README.
Il valore del @id è una stringa URL contenente uno dei token segnaposto seguenti:
Segnaposto URL
| Nome | Digitare | Obbligatorio | Note |
|---|---|---|---|
{lower_id} |
corda | Sì | ID pacchetto, in minuscolo |
{lower_version} |
corda | Sì | Versione del pacchetto, in minuscola |
Sia lower_id che lower_version vengono abbassati usando le regole implementate da . NET
System.String.ToLowerInvariant() metodo.
Il lower_version è la versione desiderata del pacchetto normalizzata usando la versione di NuGet regole di normalizzazione. Ciò significa che i metadati di compilazione consentiti dalla specifica SemVer 2.0.0 devono essere esclusi in questo caso.
Corpo della risposta
Se il pacchetto ha un file leggimi, viene restituito un codice di stato 200. Il corpo della risposta sarà il contenuto leggimi stesso.
Se il pacchetto non dispone di un file leggimi, viene restituito un codice di stato 404.