API:Edit/ja

このページは MediaWiki API ドキュメントの一部です。

MediaWiki API

• フォーマット
• エラーの報告
• 認証
  • ログイン
  • ログアウト
• クエリ
  • メタ情報
  • プロパティ
  • 一覧
• テンプレートを拡張しレンダリングする
• 編集する
  • ページを作成する/編集する
  • ページを移動する
  • ロールバック
  • ページを削除する
  • 削除されたリビジョンをリストアする
  • ページを保護/保護解除する
  • ユーザをブロック/ブロック解除する
• 内部で使う
• その他
• 実装
• クライアントコード

MediaWiki バージョン:

1.13

Requires the selected MediaWiki to have the following configuration settings set to true: $wgEnableAPI and $wgEnableWriteAPI. See Manual:DefaultSettings.php.

トークン

ページを編集するために、編集トークンが必要です。このトークンはすべてのページに対して同じですが、ログインごとに変わります。編集の衝突から保護するために(賢明なことです)、最後のリビジョンのタイムスタンプを取得することも必要です。これらの値を次のように取得します:

api.php?action=query&prop=info|revisions&intoken=edit&titles=Main%20Page

When passing this to the Edit API, always pass the token parameter last, or at least, after the text parameter.

ページの編集

action=edit で、ページの編集や作成ができます。

パラメータ

Some of these parameters seem to be revised in v1.20; for the current list, see ApiEditPage::getAllowedParams(). To see the parameter list currently in use at Wikipedia, see: {{ApiEx/ja}}

• title: 編集するページ。Cannot be used together with pageid.
• pageid: Page ID of the page to edit. Cannot be used together with title.
• section: 編集するセクション。トップのセクションに対しては0、新しいセクションに対して'new'を使う
• sectiontitle: (バージョン1.19で追加) 新しいセクションを追加する場合にセクション名として使う。省略した場合は替わりにsummaryで指定した内容が使われる
• text: 新しいページ(もしくはセクションの)内容
• token: Edit token. Especially if you are not using the md5 parameter, the token should be sent as the last parameter, or at least, after the text parameter, to prevent a bad edit from getting committed if transmission of the body is interrupted for some reason.
• summary: 編集のコメント
• minor: 設定されると、細部の編集としてマークする
• notminor: 設定されると、"Mark all my edits minor by default"とMy preferences(オプション)で有効にしていたとしても、細部の編集としてマークしない。
• bot: If set, mark the edit as bot; even if you are using a bot account the edits will not be marked unless you set this flag
• basetimestamp: 最後のリビジョンのタイムスタンプで、編集の衝突を検知するために使われます。衝突を無視するためには設定されてない状態にしておきます
• starttimestamp: Timestamp when you obtained the edit token. Used to detect edit conflicts. Leave unset and use recreate to ignore conflicts
• recreate: 設定されると、ページが削除されている間のエラー表示を抑制しページを再作成する
• createonly: 設定されると、ページが既に存在する場合にエラーをスローする
• nocreate: 設定されると、ページが存在しない場合にエラーをスローする
• watchlist: Specify how the watchlist is affected by this edit, set to one of "watch", "unwatch", "preferences", "nochange":
  • watch: ページをウォッチリストに追加する
  • unwatch: ウォッチリストからページを削除する
  • preferences: use the preference settings (Default)
  • nochange: don't change the watchlist
• md5: MD5 hash (hex) of the text parameter. If this parameter is set and the hashes don't match, the edit is rejected. This can be used to guard against data corruption
• captchaid: CAPTCHA ID from the previous request
• captchaword: Answer to the CAPTCHA
• undo: Revision ID to undo. Overrides text, prependtext and appendtext
• undoafter: Undo all revisions from undo up to but not including this one. If not set, just undo one revision

例

注: この例では、簡潔性のためだけにすべてのパラメータはGETリクエストに渡されますが。しかしながらaction=editはPOSTリクエストを必要です; GET リクエストはエラーを引き起こします。リクエストのヘッダにContent-Typeとしてapplication/x-www-form-urlencodedをセットするのを忘れないようにしてください。The token that you received is terminated with +\, this needs to be urlencoded (so it will end with %2B%5C) before it is passed back.

api.php?action=edit&title=Talk:Main_Page&section=new&summary=Hello%20World&text=Hello%20everyone!&watch&basetimestamp=2008-03-20T17:26:39Z&token=cecded1f35005d22904a35cc7b736e18%2B%5C

CAPTCHAと拡張機能のエラー

編集がCAPTCHAを必要な場合、次のようなエラーが表示されます:

<?xml version="1.0" encoding="utf-8"?>
<api>
  <edit result="Failure">
    <captcha type="math" mime="text/tex" id="509895952" question="36 + 4 = " />
  </edit>
</api>

大抵の場合、you won't get a math 数学のCAPTCHAを得られず、(urlフィールドの)画像へのURLになります。CAPTCHAを解決したとき、リクエストを再試行して下さい(この場合は captchaid=509895952&captchaword=40で)。

Other extensions that use the APIEditBeforeSaveフックを使う別のフックは通常のエラーフォーマットで説明されたどちらかのフォーマットを使うとエラーを返すことがあります。

起こり得るエラー

通常のものに加えて以下のエラーがあります:

• code: notitle
  • info: titleパラメータを設定しなけばなりません
• code: notext
  • info: textパラメータを設定しなければなりません
• code: notoken
  • info: tokenパラメータを設定しなければなりません
• code: invalidsection
  • info: sectionパラメータは整数もしくは'new'に設定しなければなりません
• code: protectedtitle
  • info: このタイトルは作ることができないように保護されています
• code: cantcreate
  • info: 新しいページを作るパーミッションを持っていません
• code: cantcreate-anon
  • info: 匿名ユーザは新しいページを作ることができません
• code: articleexists
  • info: 作ろうとした記事は既に作れたものです
• code: noimageredirect-anon
  • info: 匿名ユーザは画像のリダイレクトを作ることができません
• code: noimageredirect
  • info: 画像のリダイレクトを作るパーミッションを持っていません
• code: spamdetected
  • info: スパムのフラグメント(断片)が含まれているので、編集が拒否されました: ``wikitext''
• code: filtered
  • info: フィルタコールバック関数が編集を拒否しました
• code: contenttoobig
  • info: あなたが提供した内容はbytesバイトの記事の制限を越えます
• code: noedit-anon
  • info: 匿名ユーザはページを編集できません
• code: noedit
  • info: ページを編集するパーミッションを持っていません。
• code: pagedeleted
  • info: タイムスタンプを取得した後でページは削除されました
• code: emptypage
  • info: 新しい、空のページを作ることは許可されてません
• code: emptynewsection
  • info: Creating empty new sections is not possible.
• code: editconflict
  • info: 編集の衝突が検出されました
• code: revwrongpage
  • info: rrevid is not a revision of ``pagename''
    • Thrown if an invalid revid is given for undo or undoafter
• code: undo-failure
  • info: Undo failed due to conflicting intermediate edits
• code: missingtitle
  • (see above nocreate parameter)

Editing via Ajax

Below is sample code for editing a page via an Ajax request:

function addNewSection( summary, content, editToken ) {
    $.ajax({
        url: mw.util.wikiScript( 'api' ),
        data: {
            format: 'json',
            action: 'edit',
            title: mw.config.get( 'wgPageName' ),
            section: 'new',
            summary: summary,
            text: content,
            token: editToken
        },
        dataType: 'json',
        type: 'POST',
        success: function( data ) {
            if ( data && data.edit && data.edit.result == 'Success' ) {
                window.location.reload(); // reload page if edit was successful
            } else if ( data && data.error ) {
                alert( 'Error: API returned error code "' + data.error.code + '": ' + data.error.info );
            } else {
                alert( 'Error: Unknown result from API.' );
            }
        },
        error: function( xhr ) {
            alert( 'Error: Request failed.' );
        }
    });
}

Large texts

When using texts over 8000 characters, use "multipart/form-data" as it does not require escaping and will be significantly smaller than its urlencoded counterpart. Multipart has roughly 160 bytes of overhead for each parameter, so for seven parameters that's ~1.1kb overhead. Example:

POST http://en.wikipedia.org/w/api.php HTTP/1.1
User-Agent: Bot Framework
Content-Type: multipart/form-data; boundary=---------------------------8ce61ec834cf268
Host: en.wikipedia.org
Cookie: <removed>
Content-Length: 1348
Accept-Encoding: gzip
Connection: Keep-Alive


-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="action"

edit
-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="title"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Title here
-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="text"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Text here
-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="summary"
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Summary
-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="token"

1f287ba00a908e9622045e7b18ffa352+\
-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="assert"

user
-----------------------------8ce61ec834cf268
Content-Disposition: form-data; name="format"

xml
-----------------------------8ce61ec834cf268--