現場でよく使われているIFについて

Question

今までほとんどPHP案件をやってきたんですが、どの現場でもIFというのがほぼでてきます。

なんとなくしかわかっていないのですが
たとえば、
① お客さんが閲覧するECサイト
② ①を保守する別サイト
③ ①と②のデータのやり取りをしてあげているのがIF

という認識なのですがあっていますでしょうか？

現場入ってすぐはドキュメント熟読してますが、
DB定義書や要件定義書、基本設計所、詳細設計所は見ればそれとなくわかります。

さらにIF定義書というのがあるのですが、これは見てもさっぱりです。
さすがに社外秘なので見せられませんが、ドキュメントとしてはDB定義書と似ています。

項目物理名、項目論理名、属性（型）、バイト数、必須、形式

というように列があって行でそれぞれ定義してるみたいです。

IFがなにかよくわかっていないので、話がかみ合わないかもしれませんが
もしかしたらと思うところがあります。

前の現場ではあるデータの取り込みを担当していました。
4000行ぐらいの記述でしたが、一部を除いては全て理解していて仕様変更のソース改修にもすぐ対応できていました。
その一部とは、バッチ処理の途中（ソースの話）に
連携対象のCSVからユーザーの平文パスワードをcurl()とかいうやつでIFURLとかいうところに飛ばして、
そこで何やってるのかは知りませんが、var_dumpでの結果はそのユーザーに紐付くハッシュ化されたパスワードを取得してきているというものでした。

私の感覚としてデータの受け渡しはGET,POST,FILE,SERVERぐらい知ってれば十分だろうと思ってましたし、というかそれしか知りません。
で、そのculrというやつの結果を見て今だになんとなく感じているのは、
GET,POST,FILE,SERVERは同一サーバーの画面を跨いだデータの受け渡しに使われるのであって
curlは異なるサーバー間でのデータの受け渡しに使われるものなのかな？とか感じています。

curlを抑えればIFが理解できるのか？
というか、GET,POST,FILE,SERVERは実際に使ってきてるから詳細設計所やDB定義書も見ても

入力させる
↓
action先かheader(URL?para=$para)に遷移する
↓
name属性で受け取る
↓
なんか整形するならする
↓
受け取った値からDBレコード抽出するならする
↓
必要なカラムに必要な値を格納する

という風にやってこれたんですが
これと同じようにIF定義書を見て、「あぁ～そういうことね、なるほど、ふむふむ」と思えるには何を理解すればよいのでしょうか？

Answer 1

おっしゃる通り、IF仕様書は名前が示す通りインターフェイス、つまり、主に別のシステムまたはサブシステムなどからデータを連携(取得/送信)するときの仕様を定義するもので、ターゲットが違うだけでDB定義書(テーブル定義書)とほとんど似ております。

WebのAPIを使用することを考えるとわかりやすいかと思います。
例えば、Twitterのツイートを取得するAPIの場合

//これは実際のAPIが返すものと違います。
{
  "user" {
    "name": 
    "profile_image_url":
  },
  "text": 
  "created_at": 
}

といった感じになるかと思います。

• "user"という項目があり、その"user"には"name"と"profile_image_url"がある。それらのデータ型はstring
• "text"という項目があり(ツイート本体)、データ型はstring
• "created_at"という項目(ツイート日時)があり、データ型はstringでフォーマットは"yyyy/mm/dd hh:mm:ss"

このようにデータの内容にどういった項目があり、それぞれのデータ型、または文字列などのフォーマット形式などの定義が書かれています。

また、単にデータのやり取りだけではなく追加や更新、削除(CRUD)に関しても書かれているのもあるでしょう。どれをキーにしているか、コマンド名(URLパス)は？といった定義も含まれます。

Answer 2

機能間の連携やシステム間の連携の仕様書だと思います。
システム間でデータの連携だとかデータをやり取りする際に
データの形式や通信方法など取り決めておく必要があると思います。

おそらくサイト①の処理の途中でサイト②に（curlやajaxなどを使って）POST送信したりしているのではないでしょうか。
IF定義書にはPOSTデータの項目について書かれているのだと思います。（あるいはPOSTでJSONデータを送信しているのであればJSONデータの項目について）
また②から①にもPOSTに対するなんらかのレスポンスデータを返すのでそのデータの定義も必要です。

IF定義書があれば、サイト②の開発者はサイト①のソースコードを読まなくても、IF定義書にだけ目を通せばどのようなデータがPOSTされてくるのかというのが一目でわかるので、そのための資料と考えれば良いと思います。