MediaWiki API ir labi dokumentēts izstrādes rīku kopums, kas var veikt lielāko daļu uzdevumu vienā skriptā. API parasti izmanto, lai izstrādātu automatizētus rīkus wiki lietošanai. MediaWiki API var viegli izmantot lielākā daļa valodu, īpaši PHP (The curl features), kā arī Perl un dažas citas.
Soļi
1. solis. Izlasiet MediaWiki API dokumentāciju
Tas atrodas “api.php” tajā pašā direktorijā kā parastais index.php. Piemērs:
2. solis. Izvēlieties izvades formātu
MediaWiki piedāvā datu izvadi JSON, JSONFM, PHP (sērijveida formātā), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM un RAWFM formātā. Formāti, kas pievienoti "FM", ir diezgan drukāti HTML formātā.
3. solis. Izvēlieties darbību
MediaWiki API atbalsta šādas darbības:
- palīdzība - skatiet palīdzības ekrānu
- pieteikšanās - piesakieties MediaWiki
- opensearch - ieviest opensearch protokolu. (Ne visās MediaWiki instalācijās tas ir).
- feedwatchlist - atdod skatīšanās saraksta plūsmu.
- vaicājums - ir dažādas iespējas. Skatiet tos MediaWiki API dokumentācijā.
4. solis. Izvēlieties vaicājumu vai sarakstu
Papildus standarta darbībām MediaWiki atbalsta dažādus vaicājumus un sarakstus, piemēram, sarakstu lapas, kurās ir saite uz citu rakstu, nesen veikto izmaiņu skaita atšķirības, ieguldījumi utt.
5. darbība. Pārsūtiet ievietotos datus API, izmantojot CURL vai citu rīku, kas ļauj skriptam izmantot POST metodi
Var darboties arī GET metode.
6. solis. Pārliecinieties, ka sīkfaili tiek nosūtīti uz lietojumprogrammu (daži skripti/lietojumprogrammas var vēlēties to saglabāt apakšmapē
7. darbība. Mijiedarbojoties ar MediaWiki lietotāja interfeisu, ņemiet vērā, ka jūsu rediģēšanas marķieris tiek saglabāts lielākajā daļā rediģēšanas lapu
Rediģēšanas pilnvara tiek izmantota, lai noteiktu rediģēšanas sadursmes un izvairītos no citas jau veiktas rediģēšanas ignorēšanas (tas tiek izmantots arī atcelšanas gadījumā). Paturiet prātā, ka lietas var noiet greizi, ja rīkojaties ar wiki lietotāja saskarni. Ņemiet vērā visas izmantotās regulārās izteiksmes, lai pārliecinātos, ka tās sniegs tikai paredzēto rezultātu.
8. solis. Izlasiet wiki nosūtītos rezultātus
Rezultāti jums tiks nosūtīti HTTP atbildē, kuru var izlasīt daudzi parsētāji. Īpaši rūpējieties par izvēlēto formātu. Pārliecinieties, vai izmantojat šim formātam atbilstošo parsētāju. Parasti ir laba prakse skaidri norādīt formātu MediaWiki, pat ja tam ir noklusējuma formāts, kuru vēlaties izmantot.
Padomi
- Pirms API izmantošanas pārliecinieties, ka vietējais wiki atbalsta skriptu.
- Jūs varat uzzināt vairāk par MediaWiki, izmantojot tā API.
