עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=paraminfo
(main | paraminfo)
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
קבלת מידע על יחידות של API.
פרמטרים:
- modules
רשימה של שמות יחידות (ערכים של הפרמטרים action ו־format, או main). אפשר להגדיר תת־יחידות עם +, או כל התת־מודולים עם +*, או כל התת־מודולים באופן רקורסיבי עם +**.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- helpformat
תסדיר מחרוזות העזרה.
- אחד מהערכים הבאים: html, none, raw, wikitext
- ברירת המחדל: none
- querymodules
- מיושן.
רשימת שמות יחידות query (ערך של הפרמטר prop, meta או list). יש להשתמש ב־modules=query+foo במקום querymodules=foo.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, allrevisions, alltransclusions, allusers, authmanagerinfo, backlinks, blocks, categories, categoryinfo, categorymembers, centralnoticeactivecampaigns, centralnoticelogs, contributors, deletedrevisions, deletedrevs, duplicatefiles, embeddedin, extlinks, exturlusage, filearchive, filerepoinfo, fileusage, gadgetcategories, gadgets, imageinfo, images, imageusage, info, iwbacklinks, iwlinks, langbacklinks, langlinks, languageinfo, links, linkshere, logevents, mystashedfiles, notifications, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, unreadnotificationpages, usercontribs, userinfo, users, watchlist, watchlistraw
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- mainmodule
- מיושן.
קבלת מידע עם היחידה הראשית (העליונה). יש להשתמש ב־modules=main במקום זה.
- pagesetmodule
- מיושן.
קבלת מידע גם על יחידת pageset (שמספק את titles= וידידיו).
- formatmodules
- מיושן.
רשימת שמות תסדירים (ערכים של הפרמטר format). יש להשתמש ב־modules במקום זה.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
דוגמאות:
- הצגת מידע עבור action=parse, format=jsonfm, action=query&list=allpages, ו־action=query&meta=siteinfo.
- api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo [פתיחה בארגז חול]
- הצגת מידע עבור כל התת־מודולים של action=query.
- api.php?action=paraminfo&modules=query%2B* [פתיחה בארגז חול]