使い方

中級者向け 解説1


  1. はじめに
  2. 接続ファイルの作り方
  3. リクエストファイルの作り方

はじめに

ここでは接続・リクエストファイルの作り方について説明をします。

設定ファイルは、XML形式で設定することができ、
複雑なスクリプトは必要とせず、誰にでも簡単でわかりやすい設定が可能となっております。

設定は、必要とする項目に値を記述するだけです!

例えば、"http://example.tld" というURLにアクセスしたい場合は、
<url></url> という項目に、
<url>http://example.tld</url> アクセスしたいURLを記述するだけで完了します!

このように、設定は単純明快となっています。


ファイルの作成は、任意のテキストエディタを使って簡単に出来ます!

例えばメモ帳からでも作成できます。
メモ帳を開く
メモ帳を開いて、
新規作成
「新規作成」をして、
ファイル保存
設定を終えたらファイルに名前をつけて保存します。
UTF-8
※保存するファイルは、必ずUTF-8で保存してください。


次項より、各ファイルの設定方法を説明します。

接続ファイルの作り方

まずは接続ファイルを宣言する <connects> を設定します。

1行目はXML宣言です。これは、このまま記入してお使いください。


次に、接続を設定します。
<connect> は実際に接続を行う設定です。

3行目~5行目に接続の設定をしています。
4行目は接続名です。
これは省略しても構いませんが、接続した際にわかりやすくする為に名前を付けておきましょう。


次に、リクエストを設定します。
リクエストとは、実際にアクセスをするための設定です。
リクエストにはアクセスする為の情報(URL)などが設定されます。

リクエストは、直接リクエスト設定を記述するか、リクエストファイルへのパスを指定できます。
ここでは、直接リクエストを設定しています。

5行目~8行目の <request> の部分がリクエストの設定です。
6行目はリクエストの名前を設定しています。
これは接続名と同じように省略しても構いません。
そして、<url> の部分に アクセスしたいURLを設定しています。


以上で設定は終わりです!
UTF-8
ここまでを実際に書き込むと、ファイル内容はこのようになっています。
後はこの編集したファイルをUTF-8で保存して完了です。

リクエストファイルの作り方

リクエストの設定は、専用のファイルにまとめる事ができます。
大量のリクエストを行う場合などは、接続ファイルが肥大化してしまわないように、
専用のリクエストファイルを作成するとよいでしょう。

まずはリクエストファイルを宣言する <requests> を設定します。

1行目は接続ファイル同様にXML宣言を行います。 このままコピーしてください。


次に、リクエストを設定します。
<request> に、実際にリクエストする設定を記述します。

このリクエストは検索サイトを表示するリクエストを設定しています。

4行目は接続名です。
これは省略しても構いませんが、接続した際にわかりやすくする為に名前を付けておきましょう。
5行目の<url> の部分に アクセスしたいURLを設定しています。


更に、もう一つリクエストを追加してみましょう。

7行目はコメントです。 <!-- -->の中の文字は解釈されずに無視されます。
8行目~11行目の「サンプルリクエスト2」は、 検索サイトで検索するリクエストを設定しています。
「サンプルリクエスト1」と異なっている部分は <url> の部分だけです。


これで「検索サイトを表示する」リクエストと、「検索サイトで検索する」リクエストが完成しました!

このリクエストファイルを "request.xml" と名前をつけてUTF-8で保存してください。


次に、このリクエストファイルを接続ファイルで読み込む為の設定を行います。
先ほどの接続ファイルを編集します。

リクエストを直接していしていた5行目~8行目を編集して、

リクエストのファイルパスを指定します。

ここでは、先ほど保存したリクエストファイル "request.xml" と編集します。
リクエストのパスは、相対パスまたは絶対パスで指定できます。

これで、この接続ファイルは、
リクエストファイル "request.xml" を使用して 接続をするようになりました!


ここでは更に、接続を増やしてこのリクエストファイルを使い回す 設定をしてみましょう。
再度、接続ファイルを編集します。

8行目~11行目に、同じ接続の複製を設定しました。


最後に、編集を終えたファイルを保存して、HTTP-REQUESTで読み込んでみましょう。
ファイルの読み込み
これで、
「検索サイト」と「検索結果」にアクセスする接続2つできました!

このように、リクエストの設定をファイルに分けて設定することで、
色んな接続ファイルやその接続設定から使い回すことができるようになります!


以上の設定をファイルにまとめてありますので、下記よりダウンロードしてください。
サンプルファイルをダウンロードする