Service index

De serviceindex is een JSON-document dat het toegangspunt is voor een NuGet-pakketbron en waarmee een client-implementatie de mogelijkheden van de pakketbron kan detecteren. De serviceindex is een JSON-object met twee vereiste eigenschappen: version (de schemaversie van de serviceindex) en resources (de eindpunten of mogelijkheden van de pakketbron).

de service-index van nuget.org bevindt zich op https://api.nuget.org/v3/index.json.

Versioning

De version waarde is een parseerbare versietekenreeks van SemVer 2.0.0 die de schemaversie van de serviceindex aangeeft. De API vereist dat de versietekenreeks een groot versienummer van 3heeft. Als er niet-belangrijke wijzigingen worden aangebracht in het indexschema van de service, wordt de secundaire versie van de versietekenreeks verhoogd.

Elke resource in de serviceindex is onafhankelijk van de schemaversie van de serviceindex.

De huidige schemaversie is 3.0.0. De 3.0.0 versie is functioneel gelijk aan de oudere 3.0.0-beta.1 versie, maar moet de voorkeur hebben omdat deze beter communiceert met het stabiele, gedefinieerde schema.

HTTP methods

De service-index is toegankelijk via HTTP-methoden GET en HEAD.

Resources

De resources eigenschap bevat een matrix met resources die door deze pakketbron worden ondersteund.

Resource

Een resource is een object in de resources matrix. Het vertegenwoordigt een versiefunctie van een pakketbron. Een resource heeft de volgende eigenschappen:

Dit @id is een URL die absoluut moet zijn en moet het HTTP- of HTTPS-schema hebben.

Het @type wordt gebruikt om het specifieke protocol te identificeren dat moet worden gebruikt bij interactie met de resource. Het type resource is een ondoorzichtige tekenreeks, maar heeft over het algemeen de volgende indeling:

{RESOURCE_NAME}/{RESOURCE_VERSION}

Clients worden verwacht dat ze de @type waarden die ze begrijpen en opzoeken in de service-index van een pakketbron, moeten worden vastgelegd. De exacte @type waarden die momenteel worden gebruikt, worden opgesomd in de afzonderlijke resourcereferentiedocumenten die worden vermeld in het API-overzicht.

In het belang van deze documentatie wordt de documentatie over verschillende resources in wezen gegroepeerd op basis van de {RESOURCE_NAME} gevonden in de service-index, die vergelijkbaar is met het groeperen op scenario.

Er is geen vereiste dat elke resource een unieke @id of @type. Het is aan de client-implementatie om te bepalen welke resource de voorkeur geeft aan een andere resource. Een mogelijke implementatie is dat resources van hetzelfde of compatibel @type kunnen worden gebruikt in het geval van een verbindingsfout of serverfout.

Een resource kan een andere host of een ander domein gebruiken dan de serviceindex, maar dit kan problemen veroorzaken in omgevingen met strikte netwerkregels. Met name als uw serviceindex resources toevoegt die rechtstreeks verwijzen naar nuget.org (in plaats van proxy's of caching via uw eigen feed), werkt uw feed niet wanneer de toegang tot nuget.org wordt geblokkeerd. Als uw feed bepaalde resources gaat delegeren aan nuget.org, raden we u aan een configuratie toe te voegen, zodat wanneer uw feed wordt geïmplementeerd, de directe nuget.org verwijzing uit de serviceindex kan worden verwijderd.

Sample request

GET https://api.nuget.org/v3/index.json

Sample response

{
  "version": "3.0.0",
  "resources": [
    {
      "@id": "https://api.nuget.org/v3-flatcontainer/",
      "@type": "PackageBaseAddress/3.0.0",
      "comment": "Base URL of Azure storage where NuGet package registration info for NET Core is stored, in the format https://api.nuget.org/v3-flatcontainer/{id-lower}/{id-lower}.{version-lower}.nupkg"
    },
    {
      "@id": "https://www.nuget.org/api/v2/package",
      "@type": "PackagePublish/2.0.0"
    },
    {
      "@id": "https://api-v2v3search-0.nuget.org/query",
      "@type": "SearchQueryService/3.0.0-rc",
      "comment": "Query endpoint of NuGet Search service (primary) used by RC clients"
    },
    {
      "@id": "https://api-v2v3search-0.nuget.org/autocomplete",
      "@type": "SearchAutocompleteService/3.0.0-rc",
      "comment": "Autocomplete endpoint of NuGet Search service (primary) used by RC clients"
    },
    {
      "@id": "https://api.nuget.org/v3/registration2/",
      "@type": "RegistrationsBaseUrl/3.0.0-rc",
      "comment": "Base URL of Azure storage where NuGet package registration info is stored used by RC clients. This base URL does not include SemVer 2.0.0 packages."
    }
  ]
}