REST API 各国語サポート

REST API は、特定の修飾を使用して、HTTP 要求の一部として各国語を指定する機能をサポートします。

背景

HTTP ヘッダーを使用すると、要求に対して特定の動作を指定し、応答で追加情報を提供することができます。

HTTP ヘッダーには、情報を特定の言語で返すように要求する機能が組み込まれています。 REST API は、可能な場合はこのヘッダーを受け入れます。

各国語の指定

ACCEPT-LANGUAGE HTTP ヘッダーに 1 つ以上の言語タグを指定することができます。オプションで各タグにランクを関連付けて、優先順位順に並んだリストを指定することも可能です。このページでは、この原則について説明します。

REST API はこのヘッダーを尊重し、ACCEPT-LANGUAGE ヘッダーから言語を選択し、その言語でメッセージを返します。 ACCEPT-LANGUAGE ヘッダーに、 REST API がサポートできる言語が含まれていない場合、メッセージはデフォルト言語で戻されます。このデフォルト言語は、 REST API Web サーバーのデフォルト・ロケールに対応します。

どのようなデータが翻訳されますか? セクションでは、変換されるデータを説明します。

応答での該当言語の指定

REST API からの応答の CONTENT-LANGUAGE HTTP ヘッダーは、メッセージが返される言語を示します。

どのようなデータが翻訳されるか

エラー・メッセージと通知メッセージが翻訳されます。その他のテキストは翻訳されません。

キュー・マネージャーから返されるデータは変換されません。例えば、 REST APIを介して MQSC コマンドを実行した場合、キュー・マネージャーの応答はキュー・マネージャーのロケールになります。
apiDiscovery フィーチャーを介して公開される、 REST API用に生成された (Swagger) 文書は英語です。

サポートされる言語

英語に加えて、 REST API のエラー・メッセージおよび通知メッセージは、以下の言語に翻訳されます。

中国語 (簡体字): 言語タグ zh_CN
中国語 (繁体字): 言語タグ zh_TW
チェコ語: 言語タグ cs
フランス語: 言語タグ fr
ハンガリー語: 言語タグ hu
イタリア語: 言語タグ it
日本語: 言語タグ ja
韓国語: 言語タグ ko
ポーランド語: 言語タグ pl
ポルトガル語 (ブラジル): 言語タグ pt_BR
ロシア語: 言語タグ ru
スペイン語: 言語タグ es

例

以下の例では、Web サーバーのデフォルト・ロケールは英語です。

サポートされる言語を 1 つ指定した場合: 要求ヘッダーで ACCEPT-LANGUAGE を fr に設定します。この設定により、翻訳可能テキストの優先言語がフランス語であることを指定します。; 応答ヘッダーで CONTENT-LANGUAGE が fr に設定されます。この設定は、応答のエラー・メッセージと通知メッセージがフランス語であることを示します。
複数の言語を含むリストを指定した場合: 要求ヘッダーで ACCEPT-LANGUAGE を am, fr に設定します。この設定により、翻訳可能テキストに対して受け入れ可能な言語がアムハラ語とフランス語であり、優先言語がアムハラ語であることを指定します。; 応答ヘッダーで CONTENT-LANGUAGE が fr に設定されます。この設定は、応答内のエラー・メッセージと通知メッセージがフランス語であることを示します。これは、 REST API がアムハラ語をサポートしていないためです。
サポートされない言語を 1 つ指定した場合: 要求ヘッダーで ACCEPT-LANGUAGE を am に設定します。この設定により、翻訳可能テキストの優先言語がアムハラ語であることを指定します。; 応答ヘッダーで CONTENT-LANGUAGE が en に設定されます。この設定は、応答内のエラー・メッセージおよび通知メッセージが英語であることを示します。これは、 REST API がアムハラ語をサポートしていないためです。