sivukai / rws-php-sdk Goto Github PK

【概要】
期待されるサンプルコードの実行結果がわからない．

【内容】

ユーザ認証の必要のない、APIについては、以下のように情報を取得することができます。

<?php
require_once '/path/to/sdk-dir/autoload.php';
$client = new RakutenRws_Client();
// アプリID (デベロッパーID) をセットします
$client->setApplicationId('YOUR_APPLICATION_ID');
// アフィリエイトID をセットします(任意)
$client->setAffiliateId('YOUR_AFFILIATE_ID');
// IchibaItem/Search API から、keyword=うどん を検索します
$response = $client->execute('IchibaItemSearch', array(
  'keyword' => 'うどん'
));
// レスポンスが正しいかを isOk() で確認することができます
if ($response->isOk()) {
    // 配列アクセスによりレスポンスにアクセスすることができます。
    var_dump($response['hits']);
} else {
    echo 'Error:'.$response->getMessage();
}

上記サンプルコードの実行結果がわからない．
期待される実行結果を示すことでユーザーが正しく動作していることを認識できるようになると思います．

【例】
上記コードを実行して以下の結果が出ることを確認する．

$ php プログラム名
int(30)

【概要】
「ルート」という表現だと解釈の幅が広く（ユーザー権限など）曖昧だと感じたので修正したほうが良い．

【該当箇所】
composer を通してパッケージを入手しようとした時に

あなたの開発プロジェクトのルートに composer.json を作成します。

【修正案】
「ルートディレクトリ」または「composerをインストールしたディレクトリ」にcomposer.json を作成するの方がわかりやすいと思います．

【概要】
楽天Webサービスの登録に必要な要件をアナウンス

【手順】

事前に、楽天ウェブサービスのドキュメントページ(http://webservice.rakuten.co.jp) にて、アプリ登録を行ってください。

楽天ウェブサービスに登録する際に必要な要件のアナウンスが不足していたため，アプリ登録（アプリID (デベロッパーID) ，アフィエイトIDの発行）ができませんでした．

【提案】
ドキュメントページのリンクに加えてアカウント登録に必要な要件を提示していただけるとわかりやすいです．具体的には，以下のものが要求される旨が記載されていると親切かと思います．
・楽天アカウントの取得
・アプリ名（任意のもの）
・アプリURL（任意のもの）

composer を通してパッケージを入手しようとした時に

あなたの開発プロジェクトのルートに composer.json を作成します。
「ルート」だと表現が曖昧だと感じました．

「ルートディレクトリ」または「composerをインストールしたディレクトリ」にcomposer.json を作成するの方がわかりやすいと思います．