MediaWiki-sovellusliittymä on hyvin dokumentoitu joukko kehitystyökaluja, jotka voivat suorittaa suurimman osan tehtävistä yhdessä komentosarjassa. Sovellusliittymää käytetään tyypillisesti wikissä käytettävien automaattisten työkalujen kehittämiseen. MediaWiki -sovellusliittymää voivat käyttää useimmat kielet, erityisesti PHP (The curl -toiminnot) sekä Perl ja muutamat muut.
Askeleet
Vaihe 1. Lue MediaWiki -sovellusliittymän dokumentaatio
Se sijaitsee 'api.php' -hakemistossa samassa hakemistossa kuin tavallinen index.php. Esimerkki:
Vaihe 2. Valitse tulostusmuoto
MediaWiki tarjoaa datatulostusta muodossa JSON, JSONFM, PHP (serialized format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM ja RAWFM. FM-muotoiset tiedostomuodot ovat HTML-muodossa.
Vaihe 3. Valitse toiminto
MediaWiki -sovellusliittymä tukee seuraavia toimintoja:
- ohje - Katso ohjenäyttö
- login - Kirjaudu MediaWikiin
- opensearch - Ota käyttöön opensearch -protokolla. (Kaikissa MediaWiki -asennuksissa ei ole tätä).
- feedwatchlist - Palauta tarkkailulistan syöte.
- Kysely - Vaihtoehtoja on useita. Katso ne MediaWiki -sovellusliittymän dokumentaatiosta.
Vaihe 4. Valitse kysely tai luettelo
Normaalitoimintojen lisäksi MediaWiki tukee erilaisia kyselyitä ja luetteloita, kuten luettelosivuja, jotka sisältävät linkin toiseen artikkeliin, viimeaikaisten muutosten lukumäärää, julkaisuja jne.
Vaihe 5. Siirrä lähetetyt tiedot sovellusliittymään CURL -työkalun tai muun työkalun avulla, jonka avulla voit käyttää POST -menetelmää komentosarjassa
GET -menetelmä voi myös toimia.
Vaihe 6. Varmista, että evästeet lähetetään sovellukselle (Jotkin skriptit/sovellukset saattavat haluta tallentaa sen alikansioon
Vaihe 7. Kun käytät MediaWiki -käyttöliittymää, muista, että useimmilla muokkaussivuilla on muokkaustunnuksesi
Muokkaustunnusta käytetään määrittämään muokkaustörmäykset ja välttämään toisen jo tehdyn muokkauksen ohittamista (tätä käytetään myös palautuksessa). Muista, että asiat voivat mennä pieleen, jos käytät wikin käyttöliittymää. Muista käyttämäsi säännölliset lausekkeet varmistaaksesi, että ne tuottavat vain aiotun tuloksen.
Vaihe 8. Lue wikin lähettämät tulokset
Tulokset lähetetään sinulle HTTP -vastauksena, jonka monet jäsenet voivat lukea. Ole erityisen varovainen valitsemastasi muodosta. Varmista, että käytät kyseiselle muodolle sopivaa jäsentäjää. Yleensä on hyvä käytäntö ilmoittaa muoto suoraan MediaWikille, vaikka sillä olisi oletusmuoto, jota haluat käyttää.
Vinkkejä
- Varmista, että paikallinen wiki tukee skriptiä ennen sovellusliittymän käyttöä.
- Löydät lisää MediaWikistä sen sovellusliittymän avulla.
