MediaWiki API مجموعه ای مستند از ابزارهای توسعه است که می تواند اکثر وظایف را در یک اسکریپت انجام دهد. API معمولاً برای توسعه ابزارهای خودکار برای استفاده در ویکی استفاده می شود. API مدیاویکی را می توان به راحتی برای اکثر زبانها ، به ویژه PHP (توابع Curl) و همچنین Perl و چند زبان دیگر استفاده کرد.
مراحل
مرحله 1. اسناد MediaWiki API را بخوانید
این در 'api.php' در همان فهرست معمول index.php قرار دارد. مثال:
مرحله 2. یک فرمت خروجی را انتخاب کنید
مدیاویکی خروجی داده را در قالب JSON ، JSONFM ، PHP (قالب سریال) ، PHPFM ، WDDX ، WDDXFM ، XML ، XMLFM ، YAML ، YAMLFM و RAWFM ارائه می دهد. قالبهای پسوند "FM" در HTML بسیار چاپ می شوند.
مرحله 3. یک عمل را انتخاب کنید
API MediaWiki از اقدامات زیر پشتیبانی می کند:
- help - صفحه راهنما را ببینید
- ورود - ورود به مدیاویکی
- opensearch - پروتکل opensearch را پیاده سازی کنید. (همه نصب های MediaWiki چنین چیزی ندارند).
- feedwatchlist - فید لیست تماشا را برگردانید.
- پرس و جو - گزینه های متنوعی دارد. اسناد مدیاویکی API را برای آنها مشاهده کنید.
مرحله 4. یک پرس و جو یا یک لیست را انتخاب کنید
علاوه بر اقدامات استاندارد ، MediaWiki از پرس و جوها و لیست های مختلفی مانند فهرست صفحات حاوی پیوند به مقاله دیگر ، تعداد تغییرات اخیر ، مشارکت ها و غیره پشتیبانی می کند.
مرحله 5. داده های ارسال شده را از طریق استفاده از CURL یا ابزار دیگری که به شما امکان می دهد از روش POST به اسکریپت استفاده کنید ، به API منتقل کنید
روش GET نیز ممکن است کار کند.
مرحله 6. اطمینان حاصل کنید که کوکی ها به یک برنامه ارسال می شوند (برخی از اسکریپت ها/برنامه ها ممکن است بخواهند آن را در زیر پوشه ذخیره کنند
مرحله 7. هنگام تعامل با رابط کاربری MediaWiki ، توجه داشته باشید که کد ویرایش شما در اکثر صفحات ویرایش نگهداری می شود
توکن ویرایش برای تعیین برخوردهای ویرایش و جلوگیری از غلبه بر ویرایش دیگری که قبلاً انجام شده است ، استفاده می شود (این مورد در بازگشت نیز استفاده می شود.) به خاطر داشته باشید که اگر با رابط کاربری ویکی کار کنید ، همه چیز به هم می ریزد. حواستان به هرگونه جبرانی باشد که استفاده می کنید تا مطمئن شوید که آنها فقط نتیجه مورد نظر را انجام می دهند.
مرحله 8. نتایج ارسال شده توسط ویکی را بخوانید
نتایج در پاسخ HTTP برای شما ارسال می شود که توسط بسیاری از تجزیه کنندگان قابل خواندن است. به فرمت انتخابی خود اهمیت بیشتری دهید. مطمئن شوید که از تجزیه کننده مناسب برای آن قالب استفاده می کنید. معمولاً بیان صریح قالب در MediaWiki حتی اگر فرمت پیش فرض مورد نظر شما باشد ، یک عمل خوب است.
نکات
- قبل از استفاده از API ، مطمئن شوید که از ویکی محلی خود از اسکریپت پشتیبانی می کنید.
- با استفاده از API MediaWiki می توانید درباره آن اطلاعات بیشتری کسب کنید.
