Skip to content

AccessPoint

アクセス先情報の定義です。

Definitions

AccessPoint

Key Type Description Example Default
name string アクセス先の名称 Production
host string アクセス先のhost http://jumeaux/production
path (PathReplace) アクセス先ごとにパスを置換したい場合の設定 -
query (QueryCustomization) アクセス先ごとにクエリを上書き/削除したい場合の設定 -
proxy (string) プロキシ proxy-host
default_response_encoding (string) レスポンスのエンコーディングが不明な場合の値 utf8

proxy

スキーム(http://など)は設定しないでください。
内部でhttpとhttpsを割り当てます。

default_response_encoding

未指定の場合はレスポンスボディの中身を解析してencodingを推測します。
推測はボディが大きい場合にパフォーマンスが著しく劣化するので可能な限り指定して下さい。

content-typeにcharsetが指定されていれば本パラメータは無関係です。

PathReplace

Key Type Description Example Default
before (string) 置換対象の正規表現 ([0-9]+).json
after (string) 置換後の値 \\1.xml

after

\\1のように出現箇所を使用することもできます。

QueryCustomization

Key Type Description Example Default
overwrite (dict[list[string]]) 上書きクエリのkey-value
{"a": ["v1"], "b": ["2", "3"]}
remove (list[string]) 削除するクエリのリスト [id, name]

名前が/iで終わるキーはcase insensitive(大文字小文字を区別しない)になります。

overwrite

overwriteは既存のクエリに値を追加できません。
既にクエリの値が設定されている場合、それらは削除されます。

Examples

Production環境のアクセス先情報

name: Production
host: "http://jumeaux/production"

パス中のoneをtwoに置換する

name: Path replace normal
host: "http://jumeaux/production"
path:
  before: one
  after: two

パス中の先頭に出現する連続した数字を末尾に移動する

name: Path replace moving
host: "http://jumeaux/production"
path:
  before: "^(\\d+)(.+)"
  after: "\\2\\1"

クエリ、idを123に上書きしnameを削除する (キーの大文字小文字を区別する)

name: Query Customization case sensitive
host: "http://jumeaux/production"
query:
  overwrite:
    id: ['123']
  remove:
    - name

クエリ、idを123に上書きしnameを削除する (キーの大文字小文字を区別しない)

name: Query Customization case insensitive
host: "http://jumeaux/production"
query:
  overwrite:
    id/i: ['123']
  remove:
    - name/i

proxy-hostをプロキシとしてい経由するProduction環境のアクセス先情報

name: Production
host: "http://jumeaux/production"
proxy: proxy-host

レスポンスが不明な場合にeuc_jpと解釈させるProduction環境のアクセス先情報

name: Production
host: "http://jumeaux/production"
default_response_encoding: euc_jp