API:Data formats/de

Eingabe
Die API erhält ihre Eingaben über Parameter aus der HTTP-Abfrage im Format  oder. Jedes Modul und Submodul hat seine eigenen Parameter, die in der Dokumentation und in action=help aufgelistet sind. Sie können auch über erhalten werden.

Codierung
Alle Eingaben sollten gültiges UTF-8 in der NFC-Form sein. MediaWiki wird versuchen, andere Formate zu konvertieren, was zu einem Fehler führen kann.

Parameter mit mehreren Werten
Parameter, die mehrere Werte übernehmen, werden normalerweise übermittelt, indem die Werte durch das Pipe-Zeichen getrennt werden, z.B.. Wenn ein Wert selbst das Pipe-Zeichen enthält, nutze U+001F (Einheitentrenner) als Trennung und stelle dem Wert das Präfix U+001F voran, z.B..

Wenn ein Parameter mehrere Werte akzeptiert, ist dies explizit in seiner Modul-Dokumentation aufgeführt.

Boolesche Parameter
Wenn ein boolescher Parameter in einer HTTP-Abfrage spezifiziert wird, wird dieser unabhängig von seinem Wert als true angenommen. Für einen false-Wert lasse den Parameter komplett weg. Der beste Weg, um einen true-Parameter in einer HTTP-Abfrage zu spezifizieren, ist  zu nutzen; das folgende   stellt sicher, dass der Browser oder die HTTP-Bibliothek den "leeren" einParameter nicht verwirft.

Zeitstempel
Parameter, die Werte für Zeitstempel übernehmen, akzeptieren mehrere Zeitstempel-Formate:


 * ISO-8601-Format:.
 * Internes Zeitstempel-Format von MySQL:.
 * UNIX-Zeitstempel-Format  (Anzahl von Sekunden seit dem 1. Januar 1970).
 * UNIX-Zeitstempel-Format  (Anzahl von Sekunden seit dem 1. Januar 1970).

Zeitstempel werden immer im ISO-8601-Format ausgegeben.

Ausgabe
Das Standard-Ausgabeformat in MediaWiki ist JSON. Von allen anderen Formaten wird abgeraten.

Das Ausgabeformat sollte immer durch Nutzung von  mit yourformat als einem der folgenden Formate spezifiziert werden:



Antwort
Sofern nichts anderes angegeben ist, erlauben alle Module die Datenausgabe in allen generischen Formaten. Um die Fehlerbehebung zu vereinfachen, haben alle generischen Formate "pretty-print-HTML"-Alternativen mit einem -Suffix, z.B..

JSON-Parameter
Die folgenden Parameter können mit  und   verwendet werden:



Zusätzliche Anmerkungen

 * Die Ausgabeformate XML und PHP sind missbilligt, werden aber noch verwendet. Clients, die in PHP geschrieben sind, sollten es vermeiden, das PHP-Format zu nutzen, da dies grundsätzlich unsicher ist. Es wird derzeit nur aufgrund seiner Popularität gepflegt.
 * Es gibt viele Konvertierungsbibliotheken und Online-Konvertierer, um JSON-Antworten in andere Formate zu konvertieren — zum Beispiel konvertiert JSON-CSV in CSV.
 * Feed-Module wie der Letzte-Änderungen-Feed überschreiben die Standard-Ausgabeformate und nutzen RSS oder Atom, wie es in ihrem Parameter  spezifiziert ist. In diesen Fällen wird das im Parameter   spezifizierte Format nur genutzt, wenn es einen Fehler gibt.

Siehe auch

 * - Enthält Formate von Warnungen und Fehlern.