質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.38%

  • API

    1893questions

    APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

APIをわかりやすく伝えたい

受付中

回答 8

投稿

  • 評価
  • クリップ 3
  • VIEW 14K+

lolipop

score 471

社内のメンバーにAPIを使ってAPIを実際にたたいてみるというのをやっています。
しかしメンバーの方がAPIというものを調べても理解できないようです。

APIをわかって頂くためうまく伝えるには、なんて言えばよいでしょうか?
シンプルな回答お待ちしております。
  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 8

+8

自動販売機を例えに使います。

お金を入れる(認証)→ボタンを押す(APIコマンド)→商品を取り出す(出力結果受取)
自販機(APIバックグラウンド)が、どの様な機構で商品を出してくるか?は気にしなくていい(あるいは、させたくない)

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+4

シンプルな資料があまり無いので
Twitterを例にして口頭とホワイトボードで説明する事が多いです

TwitterAPIの例
・Twitterは外部のサーバ(サービス)だよねから説明スタート
・でも、別サイトにフィードとかいいねした人とか出してるのを見せる
・Twitterが持っている情報は自分達でも取得出来る事
・誰でも取得出来ちゃダメなので、認証するキーとかが必要
・DBにSQLで命令するのと同じように取得する構文がある
・DBを外部サービスに公開出来ないからHTTP通信で取れるようになってる

この辺りの説明をある程度理解してくれる子が殆どですが
実装者なら補足入れていきます

クライアント側
・PHPとかなら通信用にモジュールあるよ
・JSでも呼べるよ
・自分のデータとか、一般公開してるデータしか取れないよ

サーバー側
・認証(OAuthなど)しなきゃね
・データを返すフォーマットのJSON(など)にしてるよ
・負荷対策とかセキュリティ対策しなきゃね

で、必要な機能の概要を知ってもらい
今から実装するのはクライアントなのか?サーバーなのか?を理解させてから
実装に入ってもらうような流れにしています

あとは、APIとかよく使うシステムはサービスごとに規格バラバラだと皆困るから
RESTfulとかに合わせようねとか

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+4

まず、
「あるサービスの一部の機能だけを外部に公開して、それを外部のプログラムで利用できるようにするインターフェイス」
というのを前提にしておきます。


サービスというのは、Webサービスに限らずで、
たとえばファイルシステム関連のAPIは、複雑なOSのファイルシステムを簡単に操作できるようにするラッパーです。
Webサービスは言わずもがな、AmazonとかTwitterとかGoogleとかのです。


APIにする理由は、
  • 公開したくないから、一部の機能だけを操作可能にする窓口を公開する
  • 複雑だから、簡単に操作可能にする窓口を公開する
などがあるかと思います。

前者は、APIの利用者が実装の詳細を触りたくても触れません。
後者は、必ずしも実装の詳細が隠されていません。


余談ですが、私がAPIでイメージするのは、すごく複雑な仕組みだけどボタンが3つくらいしかついていない機械、です。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+2

こういった話は私も非常に困っていてどう説明してよいのやらなのですが、私の場合は「機能の分業」という風に話すようにしております。APIを使う仕事が非常に増えてきたので、私も他の方々がどのように説明しているのか伺いたいところではあります。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2014/08/22 22:28

    回答ありがとうございます。
    他の方の回答を待ってみようと思います。

    キャンセル

+2

シチュエーションが分かりませんが、
ドットインストールというサイトのGoogle map API入門などどうでしょう。

リンク内容

何のAPIか分かれば具体的な回答が有るかも知れませんよ。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

WebのAPIであれば、本質的には「ブラウザにURLを入力してアクセスすると画面が表示される」のもAPIのようなものだと思います。実際、APIのURLをブラウザに入力してアクセスすると何かが表示されるはずです。
プログラムにおけるAPIであれば、それは単に「関数やクラスが提供されている」のがAPIだと思います。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

APIの概念が分からないと人への説明ということでよかったでしょうか?

説明する相手のITリテラシーにもよると思いますが、仮にITリテラシー「低め」の方と想定した場合、身近なものに例えるとよいかと思いましたので、1例を。

「注文書を使うラーメン屋」と「APIを使うGoogle」の比較例

  • ラーメン屋 = Google (サービス提供者)
  • お客 = プログラマー (サービス利用者)
  • 注文書= API (注文の申請書)
    ※イメージ 
    注文書「ラーメンの種類/麺の固さ/味の濃さ/油の量」
    API「Google Map/地図に目印をつけたい/目印のアイコンを変えたい」

言葉でまとめると、

APIとは、「他者のサービスを利用するにあたり、サービス提供者が予め用意した注文書(書式)にそって注文し、希望のサービスを得る」というサービス授受工程の中の「注文書」みたいなもの。

みたいな説明ではどうでしょうか。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

ミドルウェアがプログラマ向けに提供する機能

というところですね。「言語本来の機能ではなく、特定の環境下でしか動作しない。」という但し書きが必要ですね。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.38%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

同じタグがついた質問を見る

  • API

    1893questions

    APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。