API:版

This page is a translated version of the page API:Revisions and the translation is 100% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎русский • ‎中文 • ‎日本語 • ‎한국어
MediaWiki バージョン:
1.8

ページ (群) の版の情報を取得する GET リクエストです。

APIの説明文書


prop=revisions (rv)

(main | query | revisions)
  • This module requires read rights.
  • This module can be used as a generator.
  • Source: MediaWiki
  • License: GPL-2.0-or-later

Get revision information.

May be used in several ways:

  1. Get data about a set of pages (last revision), by setting titles or pageids.
  2. Get revisions for one given page, by using titles or pageids with start, end, or limit.
  3. Get data about a set of revisions by setting their IDs with revids.
Parameters:
rvprop

Which properties to get for each revision:

ids
The ID of the revision.
flags
Revision flags (minor).
timestamp
The timestamp of the revision.
user
User that made the revision. If the user has been revision deleted, a userhidden property will be returned.
userid
User ID of the revision creator. If the user has been revision deleted, a userhidden property will be returned.
size
Length (bytes) of the revision.
slotsize
Length (bytes) of each revision slot.
sha1
SHA-1 (base 16) of the revision. If the content has been revision deleted, a sha1hidden property will be returned.
slotsha1
SHA-1 (base 16) of each revision slot. If the content has been revision deleted, a sha1hidden property will be returned.
contentmodel
Content model ID of each revision slot.
comment
Comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
parsedcomment
Parsed comment by the user for the revision. If the comment has been revision deleted, a commenthidden property will be returned.
content
Content of each revision slot. If the content has been revision deleted, a texthidden property will be returned.
tags
Tags for the revision.
roles
List content slot roles that exist in the revision.
parsetree
Deprecated. Use action=expandtemplates or action=parse instead. The XML parse tree of revision content (requires content model wikitext).
Values (separate with | or alternative): comment, content, contentmodel, flags, ids, parsedcomment, roles, sha1, size, slotsha1, slotsize, tags, timestamp, user, userid, parsetree
Default: ids|timestamp|flags|comment|user
rvslots

Which revision slots to return data for, when slot-related properties are included in rvprops. If omitted, data from the main slot will be returned in a backwards-compatible format.

Values (separate with | or alternative): main
To specify all values, use *.
rvlimit

Limit how many revisions will be returned.

May only be used with a single page (mode #2).
Type: integer or max
The value must be between 1 and 500.
rvexpandtemplates
Deprecated.

Use action=expandtemplates instead. Expand templates in revision content (requires rvprop=content).

Type: boolean (details)
rvgeneratexml
Deprecated.

Use action=expandtemplates or action=parse instead. Generate XML parse tree for revision content (requires rvprop=content).

Type: boolean (details)
rvparse
Deprecated.

Use action=parse instead. Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.

Type: boolean (details)
rvsection

Only retrieve the content of this section number.

rvdiffto
Deprecated.

Use action=compare instead. Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.

rvdifftotext
Deprecated.

Use action=compare instead. Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.

rvdifftotextpst
Deprecated.

Use action=compare instead. Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.

Type: boolean (details)
rvcontentformat
Deprecated.

Serialization format used for rvdifftotext and expected for output of content.

One of the following values: application/json, application/octet-stream, application/unknown, application/x-binary, text/css, text/javascript, text/plain, text/unknown, text/x-wiki, unknown/unknown
rvstartid

Start enumeration from this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
Type: integer
rvendid

Stop enumeration at this revision's timestamp. The revision must exist, but need not belong to this page.

May only be used with a single page (mode #2).
Type: integer
rvstart

From which revision timestamp to start enumeration.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvend

Enumerate up to this timestamp.

May only be used with a single page (mode #2).
Type: timestamp (allowed formats)
rvdir

In which direction to enumerate:

newer
List oldest first. Note: rvstart has to be before rvend.
older
List newest first (default). Note: rvstart has to be later than rvend.
May only be used with a single page (mode #2).
One of the following values: newer, older
Default: older
rvuser

Only include revisions made by user.

May only be used with a single page (mode #2).
Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
rvexcludeuser

Exclude revisions made by user.

May only be used with a single page (mode #2).
Type: user, by any of user name, IP, interwiki name (e.g. "prefix>ExampleName") and user ID (e.g. "#12345")
rvtag

Only list revisions tagged with this tag.

rvtoken
Deprecated.

Which tokens to obtain for each revision.

Values (separate with | or alternative): rollback
rvcontinue

When more results are available, use this to continue.

例 1: 複数ページから更新履歴データを取得

GET リクエスト

上記のリクエストでは、題名が API メインページ のページから更新情報を抽出することが目的です。

レスポンス

サンプル コード

Python

#!/usr/bin/python3

"""
    get_pages_revisions.py

    MediaWiki API Demos
    Demo of `Revisions` module: Get revision data with content for pages
    with titles [[API]] and [[Main Page]]

    MIT License
"""

import requests

S = requests.Session()

URL = "https://www.mediawiki.org/w/api.php"

PARAMS = {
    "action": "query",
    "prop": "revisions",
    "titles": "API|Main Page",
    "rvprop": "timestamp|user|comment|content",
    "rvslots": "main",
    "formatversion": "2",
    "format": "json"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

PAGES = DATA["query"]["pages"]

for page in PAGES:
    print(page["revisions"])

PHP

<?php
/*
    get_pages_revisions.php

    MediaWiki API Demos
    Demo of `Revisions` module: Get revision data with content for pages with titles [[API]] and [[Main Page]]

    MIT License
*/

$endPoint = "https://www.mediawiki.org/w/api.php";
$params = [
    "action" => "query",
    "prop" => "revisions",
    "titles" => "API|Main Page",
    "rvprop" => "timestamp|user|comment|content",
    "rvslots" => "main",
    "formatversion" => "2",
    "format" => "json"
];

$url = $endPoint . "?" . http_build_query( $params );

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );

$result = json_decode( $output, true );

foreach( $result["query"]["pages"] as $k => $v ) {
    var_dump( $v["revisions"] );
}

JavaScript

/*
    get_pages_revisions.js

    MediaWiki API Demos
    Demo of `Revisions` module: Get revision data with content for pages with titles [[API]] and [[Main Page]]

    MIT License
*/

var url = "https://www.mediawiki.org/w/api.php";

var params = {
    action: "query",
    prop: "revisions",
    titles: "API|Main Page",
    rvprop: "timestamp|user|comment|content",
    rvslots: "main",
    formatversion: "2",
    format: "json"
};

url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});

fetch(url)
    .then(function(response){return response.json();})
    .then(function(response) {
        var pages = response.query.pages;
        for (var p in pages) {
            console.log(pages[p].revisions);
        }
    })
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	get_pages_revisions.js

	MediaWiki API Demos
	Demo of `Revisions` module: Get revision data with content for pages with
	titles [[API]] and [[Main Page]]

	MIT License
*/

var params = {
		action: 'query',
		prop: 'revisions',
		titles: 'API|Main Page',
		rvprop: 'timestamp|user|comment|content',
		rvslots: 'main',
		formatversion: '2',
		format: 'json'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	var pages = data.query.pages,
		p;
	for ( p in pages ) {
		console.log( pages[ p ].revisions );
	}
} );

例 2: 個別のページについて日付・利用者で絞り込んだ直近5件の更新履歴を取得

GET リクエスト

上記のリクエストでは、目的は特定のページ API:Geosearch について、2018年7月1日つまり 2018-07-01以降の直近の更新5版についてデータの抽出です。ただし利用者 SSethi (WMF) による更新を除外しています。

レスポンス

サンプル コード

例 3: リダイレクトをたどって特定ページの直近の更新履歴を取得

GET リクエスト

上記のリクエストでは、目的はリダイレクトを経て特定のページAntiSpoof で実行された更新のデータを抽出することです。 ページAntiSpoof は ページExtension:AntiSpoof にリダイレクトされるため、実際の更新データはページ Extension:AntiSpoof から抽出します。

レスポンス

起こりうるエラー

コード 情報
rvdiffto rvdiffto は "prev"、"next"、"cur" (「以前」「以降」「現在の版」) もしくは正の整数を取ります。
rvnosuchrevid IDというID (特定版番号) に対する更新はありません。
rvnosuchsection 更新版 rID には section という節はありません。
rvrevids パラメータ revids= は一覧オプションとは同時に使えない可能性があります (すなわち limit、startid、endid、dirNewer、start、end)。
rvmultpages ページ題名、ページ識別子(pageid) または生成器を使って複数ページを利用することはできますが、パラメータのうちlimit、startid、endid、dirNewer、user、excludeuser、start、end は対象が単一ページだと使えません。
rvaccessdenied 現在の利用者には title を閲読する権限がありません
rvbadparams パラメータ start と startid は同時に使えません
rvbadparams パラメータ end と endid は同時に使えません
rvbadparams パラメータ user と excludeuser は同時に使えません
invalidparammix titles, pageids or a generator was used to supply multiple pages, but the rvlimit, rvstartid, rvendid, rvdir=newer, rvuser, rvexcludeuser, rvstart, and rvend parameters may only be used on a single page.
accessdenied You are not allowed to view title.
badid_startid No revision was found for parameter startid.
badid_endid No revision was found for parameter endid.

追加的な注記

  • ページの特定に使うパラメータは pageids もしくは titles。 個別の更新を特定するパラメータは revidsAPI:クエリ を参照してください。
  • Slots の特定にはパラメータ rvslots も使用可能。 パラメータが無い場合、API は単に slot の情報を返します。
  • (enum) とマークされたパラメータを使う場合、titles= には題名1件のみふくむことができます。
  • このモジュールはバージョン 1.25 以前は、生成器の機能がありませんでした。
  • このモジュールの差分関連の機能は、バージョン 1.30 以降廃止され、API:比較 へ移行されました。
  • このクエリのコードは、git リポジトリのApiQueryRevisions.phpにあります。

パラメーターの履歴

  • v1.32: rvslots,roles を導入しました rvcontentformat を廃止予定にしました
  • v1.30: parsetree,rvprop,rvexpandtemplates,rvparse,rvdiffto,rvdifftotext,rvdifftotextpst を廃止予定にしました
  • v1.27: rvdifftotextpst を導入しました
  • v1.26: parsetree を導入しました rvgeneratexml を廃止予定にしました
  • v1.24: rvtoken を廃止予定にしました
  • v1.21: contentmodel,rvcontentformat を導入しました
  • v1.19: sha1,rvparse を導入しました
  • v1.17: userid,rvparse を導入しました
  • v1.16: parsedcomment,tags,rvdifftotext,rvtag を導入しました
  • v1.15: rvdiffto,rvcontinue を導入しました
  • v1.14: rvgeneratexml を導入しました
  • v1.13: rvsection を導入しました
  • v1.12: rvexpandtemplates,rvtoken を導入しました
  • v1.11: ids,flags,size,rvuser,rvexcludeuser を導入しました

関連項目