MediaWiki API- ն զարգացման գործիքների լավ փաստաթղթավորված հավաքածու է, որը կարող է առաջադրանքների մեծ մասը կատարել մեկ սցենարում: API- ն սովորաբար օգտագործվում է վիքիում օգտագործվող ավտոմատացված գործիքների մշակման համար: MediaWiki API- ն կարող է հեշտությամբ օգտագործվել լեզուների մեծ մասի, մասնավորապես PHP- ի (The curl գործառույթների), ինչպես նաև Perl- ի և մի քանի այլ լեզուների կողմից:
Քայլեր
Քայլ 1. Կարդացեք MediaWiki API- ի փաստաթղթերը:
Այն գտնվում է «api.php» հասցեում `նույն index.php- ի նույն գրացուցակում: Օրինակ ՝
Քայլ 2. Ընտրեք ելքային ձևաչափ:
MediaWiki- ն առաջարկում է տվյալների ելք JSON, JSONFM, PHP (սերիականացված ձևաչափ), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM և RAWFM տեսքով: «FM» ածանց ձևաչափերը բավականին տպագրված են HTML- ում:
Քայլ 3. Ընտրեք գործողություն:
MediaWiki API- ն աջակցում է հետևյալ գործողություններին.
- օգնություն - Տեսեք օգնության էկրանը
- մուտք - Մուտք գործեք MediaWiki
- opensearch - Իրականացրեք opensearch արձանագրությունը: (MediaWiki- ի ոչ բոլոր տեղադրումներն ունեն դա):
- feedwatchlist - Վերադարձեք դիտացանկի թարմացվող բովանդակություն:
- հարցում - Ունի մի շարք տարբերակներ: Նրանց համար տեսեք MediaWiki API- ի փաստաթղթերը:
Քայլ 4. Ընտրեք հարցում կամ ցուցակ:
Բացի ստանդարտ գործողություններից, MediaWiki- ն աջակցում է տարբեր հարցումների և ցուցակների, ինչպիսիք են ՝ այլ հոդվածի հղում պարունակող էջերի ցուցակագրումը, վերջին փոփոխությունների քանակը, ներդրումները և այլն:
Քայլ 5. Տեղադրված տվյալները փոխանցեք API- ին CURL- ի կամ այլ գործիքի միջոցով, որը թույլ է տալիս օգտագործել POST մեթոդը սցենարին:
GET մեթոդը կարող է նաև աշխատել:
Քայլ 6. Համոզվեք, որ թխուկները ուղարկվում են ծրագրին (որոշ սցենարներ/ծրագրեր կարող են ցանկություն ունենալ այն պահել ենթապանակում:
Քայլ 7. MediaWiki- ի ինտերֆեյսի հետ շփվելիս հաշվի առեք ձեր խմբագրման նշանը, որը պահվում է խմբագրման էջերի մեծ մասում:
Խմբագրման նշանը օգտագործվում է խմբագրման բախումները որոշելու և արդեն կատարված մեկ այլ խմբագրման գերակայությունից խուսափելու համար (սա օգտագործվում է նաև հետադարձման դեպքում): Հիշեք, որ ամեն ինչ ավելի հեշտ է շեղվել, եթե գործում եք վիքիի ինտերֆեյսի միջոցով: Beգուշացեք ձեր օգտագործած ցանկացած ռեգեքսից `համոզվելու համար, որ դրանք միայն կանեն նախատեսված արդյունքը:
Քայլ 8. Կարդացեք վիքիի ուղարկած արդյունքները:
Արդյունքները կուղարկվեն ձեզ HTTP պատասխանով, որը կարող են կարդալ բազմաթիվ վերլուծիչներ: Լրացուցիչ հոգ տանել ձեր ընտրած ձևաչափի մասին: Համոզվեք, որ օգտագործում եք համապատասխան վերլուծիչ այդ ձևաչափի համար: Սովորաբար լավ պրակտիկա է ՝ հստակ ձևաչափը նշել MediaWiki- ին, նույնիսկ եթե այն ունի կանխադրված ձևաչափ, որը ցանկանում եք օգտագործել:
Խորհուրդներ
- API- ն օգտագործելուց առաջ համոզվեք, որ ունեք ձեր տեղական վիքիի սցենարի աջակցությունը:
- Դուք կարող եք ավելին գտնել MediaWiki- ի մասին ՝ օգտագործելով դրա API- ն:
