Vorlage:API-Methode

Version vom 9. April 2015, 12:01 Uhr von Basti (Diskussion | Beiträge) (param dokumentiert)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Dies ist die Vorlage für Methoden der Labor-API.

Beispiel

/api/fireworks/

Startet Feuerwerkskörper.

Rückgabewerte: NameTypBeschreibung
success boolean Status der Operation

Verwendung

{{API-Methode
|name= 
|beschreibung= 
|param1=<Variablenname>, <Variablentyp>, <Beschreibung>
|...
|param5=<Variablenname>, <Variablentyp>, <Beschreibung>
|return1=<Variablenname>, <Variablentyp>, <Beschreibung>
|...
|return20=<Variablenname>, <Variablentyp>, <Beschreibung>
}}

Die Rückgabewerte sind alle optional.