Änderungen von Dokument Schnittstellen

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -24,17 +24,23 @@
24	24
25	25	Grundsätzlich legen wir unsere API's für eine möglichst lange Betriebsphase und somit für eine lange Versionskompatibilität aus. Im Nachfolgenden finden Sie unsere Vorgehensweise im Detail.
26	26
27		-Wir behalten (soweit technisch möglich) immer die zwei Versionen online. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach der Abkündigung wird die Version und alle beinhalteten Minor-Versionen nicht mehr erreichbar sein.
	27	+Wir behalten (soweit technisch möglich) immer zwei Versionen online. Sobald eine neue Version hinzukommt, wird die älteste Version mit einem zeitlichen Horizont von mindestens 6 Monaten abgekündigt. Nach der Abkündigung wird die Version und alle beinhalteten Minor-Versionen nicht mehr erreichbar sein.
28	28
29		-Eine neue Major-Version kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen. Dies sind z.B.:
	29	+Eine neue **Major-Version (1.x)** kann Änderungen beinhalten, welche nicht mehr abwärtskompatibel sein müssen (Abhängig von Ihrer Implementierung). Dies sind z.B.:
30	30
31		-* Zugang
32		-* Endpunkte
33		-* Parameter
34		-* Response
	31	+* Authentifizierungsmethoden
	32	+* Umbenennung und Löschung von Endpunkten
	33	+* Löschung von HTTP-Methoden an vorhandenen Endpunkten
	34	+* Umbenennung und Löschung von Parametern
	35	+* Restrukturierung des Response-Objekt
35	35
36		-Eine neue Minor-Version ist per Definition abwärtskompatibel zur Major-Version. Dabei können Sie aber folgende Dinge ändern:
	37	+Eine neue **Minor-Version (x.1)** ist per Definition abwärtskompatibel zur **Major-Version**. Dabei können sich aber folgende Dinge ändern:
37	37
38	38	* Zusätzliche Endpunkte
39		-* Weitere Parameter für eine Abfrage (z.B. Filterfunktion)
40		-* Erweitertes Response (weitere Ausgaben in der Antwort)
	40	+* Zusätzliche HTTP-Methoden an Endpunkten
	41	+* Weitere (optionale) Parameter für eine Abfrage (z.B. Filterfunktion)
	42	+* Erweitertes Response-Objekt
	43	+
	44	+# Versionshistorie
	45	+
	46	+Zu jeder API finden Sie als Unterknoten jeweils den "Release-Notes"-Artikel. Beispiel [[Submission-API|doc:.01_SubmissionAPI.Release-Notes.WebHome]].