...
Mit einem GET
-Request auf die Basis-Adresse können Sie eine Liste aller Endpunkte in der API abrufen.
Paging
TODO: Die aktuell generierten Link-Header sind nicht korrekt. Evtl. wäre es besser stattdessen die page, und per-page-Logik von Github zu nutzen.
Einige Anfragen begrenzen die Menge an zurückgelieferten Elemente und paginieren die Ergebnisliste. Um durch die Ergebnisliste zu blättern, kann der Query-Parameter offset
angeben werden. Dieser gibt an, mit welchem Element die Liste beginnen soll.
...
Die Zählung beginnt bei 0. Wenn der Parameter nicht angegeben wird, wird mit dem ersten Element begonnen. Die Seitengröße kann mit dem Parameter count
beeinflusst werden. Standardmäßig werden 20 Elemente ausgegeben.
Link-Header
Zum vereinfachten Blättern durch die Ergebnislisten, enthalten die Antworten der URN-Service API einen HTTP Link-Header, der auf die erste, letzte, vorhergehende und folgende Ergebnisseite verweisen:
Codeblock |
---|
Link: <https://api.nbn-resolving.org/v2/urns?offset=20&count=20>; rel="next",<https://api.nbn-resolving.org/v2/urns?offset=0&count=20>; rel="last" |
Referenz
Eine detaillierte Übersicht über alle Befehle der REST-API wird als Teil der REST-API unter docs/index.html
angeboten.
...