Archive:Ask-API
Die Programmschnittstelle Ask-API ermöglicht es, unter Zuhilfenahme der MediaWiki API (en), eingebettete Abfragen auszuführen und die entsprechenden Ergebnisse serialisiert, in einem der unterstützten Formate, ausgegeben zu bekommen. Es sind zwei API-Module verfügbar, die sich darin unterscheiden, wie die Abfrage angegeben werden muss. Indes ist die Ausgabe der Abfrageergebnisse jeweils identisch.
Ask[edit]
Das Modul „Ask“ unterstützt Abfragen mit einem Parameter. Dabei wird die selbe Zeichenkette jeweils im URL-kodiertem Format an die Parserfunktion #ask weitergegeben.
- Beispiel
api.php?action=ask&query=[[Zuletzt ge%E4ndert::%2B]]|%3FZuletzt ge%E4ndert|sort%3DZuletzt ge%E4ndert|order%3Ddesc&format=jsonfm
Die entsprechende eingebettete Abfrage sähe wie folgt aus:
{{#ask: [[Zuletzt geändert::+]] | ?Zuletzt geändert | sort=Zuletzt geändert | order=desc | format=json }}
Askargs[edit]
Das Modul „Askargs“ zielt darauf die Argumente in einer nicht serialisierten Form, unter Nutzung von so wenig Abfragesyntax als möglich, aufzunehmen. Es werden insgesamt drei Argumente von diesem Modul unterstützt:
- „conditions“: Die für die Seitenauswahl notwendigen Bedingungen.
- „printouts“: Die für die Ergebnisausgabe notwendigen Bedingungen, d. h. die anzuzeigenden Attributwerte.
- „parameters“: Die für die Ergebnisanzeige notwendigen Bedingungen sowie Ausgabeformate, d. h. die zu nutzenden Formatierungs- und Ausgabeoptionen.
- Beispiel
api.php?action=askargs&conditions=Zuletzt ge%E4ndert::%2B&printouts=Modification date¶meters=|sort%3DZuletzt ge%E4ndert|order%3Ddesc&format=jsonfm
Die entsprechende eingebettete Abfrage sähe wie folgt aus:
{{#ask: [[Zuletzt geändert::+]] | ?Zuletzt geändert | sort=Zuletzt geändert | order=desc | format=json }}
Dokumente[edit]
- E-Mail des RFC auf der SMW-Entwicklermailingliste (en)
- Video des Konferenzbeitrags auf der SMWCon Herbst 2011 (en)
Siehe auch[edit]
- Softwareerweiterung SMWAskAPI