From 364c4863dd8acb1caa13486d09ee9bc1d8f94764 Mon Sep 17 00:00:00 2001 From: Nobuo Kihara Date: Sun, 22 Feb 2015 14:00:01 +0900 Subject: [PATCH] docs/guide-ja/rest reviewing [ci skip] --- docs/guide-ja/rest-quick-start.md | 8 ++++---- docs/guide-ja/rest-resources.md | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/guide-ja/rest-quick-start.md b/docs/guide-ja/rest-quick-start.md index d82d208..535b363 100644 --- a/docs/guide-ja/rest-quick-start.md +++ b/docs/guide-ja/rest-quick-start.md @@ -90,8 +90,8 @@ API が JSON 形式で入力データを受け取ることが出来るように * `OPTIONS /users`: エンドポイント `/users` に関してサポートされている動詞を示す * `OPTIONS /users/123`: エンドポイント `/users/123` に関してサポートされている動詞を示す -> Info|情報: Yii は、エンドポイントとして使用されるコントローラの名前を自動的に複数形にします。 -> これは [[yii\rest\UrlRule::$pluralize]] プロパティを使って構成することが可能です。 +> Info|情報: Yii はコントローラの名前を自動的に複数形にしてエンドポイントとして使用します。 +> この振る舞いは [[yii\rest\UrlRule::$pluralize]] プロパティを使って構成することが可能です。 作成した API は、次のように、`curl` コマンドでアクセスすることが出来ます。 @@ -170,7 +170,7 @@ Content-Type: application/json; charset=UTF-8 ``` > Tip|ヒント: URL `http://localhost/users` を入力すれば、ウェブブラウザ経由で API にアクセスすることも出来ます。 - ただし、特殊なリクエストヘッダを送信するためには、何らかのブラウザプラグインが必要になるかも知れません。 + ただし、特殊なリクエストヘッダを送信するためには、何らかのブラウザプラグインが必要になるでしょう。 ご覧のように、レスポンスヘッダの中には、総ユーザ数やページ数などの情報が書かれています。 また、データの他のページへナビゲートすることを可能にするリンクもあります。 @@ -195,4 +195,4 @@ Yii の RESTful API フレームワークを使う場合は、API エンドポ [[yii\rest\UrlRule]] を使って API エンドポイントへのルーティングを簡単にすることが出来ます。 -これは必須ではありませんが、RESTful API は、保守を容易にするために、ウェブのフロントエンドやバックエンドとは別の独立したアプリケーションとして開発することを推奨します。 +これは要求されてはいませんが、RESTful API は、保守を容易にするために、ウェブのフロントエンドやバックエンドとは別の独立したアプリケーションとして開発することが推奨されます。 diff --git a/docs/guide-ja/rest-resources.md b/docs/guide-ja/rest-resources.md index 9c21592..6e4f016 100644 --- a/docs/guide-ja/rest-resources.md +++ b/docs/guide-ja/rest-resources.md @@ -2,7 +2,7 @@ ======== RESTful API は、つまるところ、*リソース* にアクセスし、それを操作するものです。 -MVC の枠組の中では、リソースは [models](structure-models.md) として見ることが出来ます。 +MVC の枠組の中では、リソースは [モデル](structure-models.md) として見ることが出来ます。 リソースをどのように表現すべきかについて制約がある訳ではありませんが、Yii においては、通常は、次のような理由によって、リソースを [[yii\base\Model]] またはその子クラス (例えば [[yii\db\ActiveRecord]]) のオブジェクトとして表現することになります。 @@ -13,8 +13,8 @@ MVC の枠組の中では、リソースは [models](structure-models.md) とし * [[yii\db\ActiveRecord]] は DB データのアクセスと操作に対する強力なサポートを提供しています。 リソースデータがデータベースに保存されているときは、アクティブレコードが最適の選択です。 -この節では、主として、[[yii\base\Model]] クラス (またはその子クラス) から拡張したリソースクラスにおいて、どのデータを RESTful API を通じて返すことが出来るかを指定する方法を説明します。 -リソースクラスが [[yii\base\Model]] から拡張しない場合は、全てのパブリックなメンバ変数が返されます。 +この節では、主として、[[yii\base\Model]] クラス (またはその子クラス) から拡張したリソースクラスにおいて、RESTful API を通じて返すことが出来るデータを指定する方法を説明します。 +リソースクラスが [[yii\base\Model]] から拡張したものでない場合は、全てのパブリックなメンバ変数が返されます。 ## フィールド @@ -93,7 +93,7 @@ public function fields() ### `extraFields()` をオーバーライドする -デフォルトでは、[[yii\base\Model::extraFields()]] は何も返しませんが、[[yii\db\ActiveRecord::extraFields()]] は DB から取得されたリレーションの名前を返します。 +デフォルトでは、[[yii\base\Model::extraFields()]] は何も返さず、[[yii\db\ActiveRecord::extraFields()]] は DB から取得されたリレーションの名前を返します。 `extraFields()` によって返されるデータの形式は `fields()` のそれと同じです。 通常、`extraFields()` は、主として、値がオブジェクトであるフィールドを指定するのに使用されます。