MediaWiki API-бұл көптеген құжаттарды бір сценарийде орындай алатын, жақсы құжатталған әзірлеу құралдарының жиынтығы. API әдетте викиде қолдануға арналған автоматтандырылған құралдарды жасау үшін қолданылады. MediaWiki API көптеген тілдерде, әсіресе PHP (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 пайдаланушы интерфейсімен әрекеттескенде, өңдеу беттерінде сақталатын өңдеу белгісін ескеріңіз
Өңдеу белгісі өңдеудің қақтығыстарын анықтау үшін және бұрын жасалған басқа түзетуді болдырмауға мүмкіндік беру үшін қолданылады (Бұл кері қайтару кезінде де қолданылады.). Есіңізде болсын, егер сіз викидің қолданушы интерфейсімен жұмыс жасасаңыз, жағдай оңай болады. Сіз күтілетін нәтижені беретініне көз жеткізу үшін пайдаланатын кез келген рекстерді есте сақтаңыз.
Қадам 8. Уики жіберген нәтижелерді оқыңыз
Нәтижелер сізге көптеген талдаушылар оқи алатын HTTP жауабында жіберіледі. Сіз таңдаған форматқа ерекше назар аударыңыз. Бұл пішімге сәйкес талдағышты қолданғаныңызға көз жеткізіңіз. MediaWiki -де, егер сізде әдепкі формат болса да, форматты нақты көрсету әдетте жақсы тәжірибе болып табылады.
Кеңестер
- API қолданбас бұрын жергілікті вики сценарийі бар екеніне көз жеткізіңіз.
- MediaWiki туралы қосымша ақпаратты оның API көмегімен білуге болады.
