Skip to content

Docs: API-Version über Query-Parameter wählen

Warum?

Um Links zu konkreten API-Versionen verschicken zu können, sollte die Version einer API im Entwicklungsportal über einen Query-Parameter auswählbar sein.

Beispiel: https://docs.fitko.de/fit-connect/docs/apis/routing-api/?version=1.1.0-rc1

Relevante Links und Bemerkungen

Akzeptanzkriterien

  1. Bei Angabe des Query-Parameters ?version=<version> wird die dort angegebene Version angezeigt.
  2. Ist die via Query-Parameter gewählte Version nicht vorhanden, wird stattdessen wie bisher die standardmäßig ausgewählte Version angezeigt.
  3. Ist der Query-Parameter nicht vorhanden (?) oder leer (?version=), dann wird wie bisher die standardmäßig ausgewählte Version angezeigt.
  4. Im Drop-Down-Menü ist immer die gerade angezeigte API-Version ausgewählt (auch bei Auswahl via Query-Parameter).
  5. Der Text "Die aktuell angezeigte Version der API ist x.x.x" wird entfernt (ist inzwischen redundant).
  6. Der Text "(im Format OpenAPI herunterladen)." wird ersetzt durch "Diese API-Spezifikation im Format OpenAPI herunterladen."

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

Edited by Mark Kane