API на MediaWiki е добре документиран набор от инструменти за разработка, които могат да изпълняват по-голямата част от задачите в един скрипт. API обикновено се използва за разработване на автоматизирани инструменти за използване в wiki. API на MediaWiki може лесно да се използва от повечето езици, по -специално 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. Изберете действие
API на MediaWiki поддържа следните действия:
- помощ - Вижте екрана за помощ
- вход - Влезте в MediaWiki
- opensearch - Прилагане на протокола opensearch. (Не всички инсталации на MediaWiki имат това).
- feedwatchlist - Връщане на емисия на списък за наблюдение.
- заявка - Има различни опции. Вижте документацията за API на MediaWiki за тях.
Стъпка 4. Изберете заявка или списък
Освен стандартните действия, MediaWiki поддържа различни заявки и списъци, като например страници със списъци, които съдържат връзка към друга статия, брой на разликите в последните промени, приноси и т.н.
Стъпка 5. Предайте публикуваните данни на API чрез използването на CURL или друг инструмент, който ви позволява да използвате метода POST към скрипта
Методът GET също може да работи.
Стъпка 6. Не забравяйте да запазите бисквитките, изпратени до приложение (Някои скриптове/приложения може да пожелаят да ги съхраняват в подпапка
Стъпка 7. Когато взаимодействате с потребителския интерфейс на MediaWiki, имайте предвид, че вашият маркер за редактиране се съхранява в повечето страници за редактиране
Токенът за редактиране се използва за определяне на сблъсъци при редактиране и избягване на отмяна на друго вече направено редактиране (Това се използва и при връщане назад). Имайте предвид, че е по -лесно нещата да се объркат, ако действате с потребителския интерфейс на wiki. Вземете предвид всички регулярни изрази, които използвате, за да сте сигурни, че те ще постигнат само желания резултат.
Стъпка 8. Прочетете резултатите, изпратени от wiki
Резултатите ще ви бъдат изпратени в HTTP отговор, който може да бъде прочетен от много анализатори. Погрижете се допълнително за избрания от вас формат. Уверете се, че използвате подходящия анализатор за този формат. Обикновено е добра практика изрично да посочите формата в MediaWiki, дори ако той има формат по подразбиране, който искате да използвате.
Съвети
- Уверете се, че имате поддръжката на скрипта от вашата локална wiki, преди да използвате API.
- Можете да намерите повече за MediaWiki, като използвате неговия API.
