社内のメンバーにAPIを使ってAPIを実際にたたいてみるというのをやっています。
しかしメンバーの方がAPIというものを調べても理解できないようです。
APIをわかって頂くためうまく伝えるには、なんて言えばよいでしょうか?
シンプルな回答お待ちしております。
気になる質問をクリップする
クリップした質問は、後からいつでもMYページで確認できます。
またクリップした質問に回答があった際、通知やメールを受け取ることができます。
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
回答8件
0
自動販売機を例えに使います。
お金を入れる(認証)→ボタンを押す(APIコマンド)→商品を取り出す(出力結果受取)
自販機(APIバックグラウンド)が、どの様な機構で商品を出してくるか?は気にしなくていい(あるいは、させたくない)
投稿2014/10/02 08:50
総合スコア32
0
まず、
「あるサービスの一部の機能だけを外部に公開して、それを外部のプログラムで利用できるようにするインターフェイス」
というのを前提にしておきます。
サービスというのは、Webサービスに限らずで、
たとえばファイルシステム関連のAPIは、複雑なOSのファイルシステムを簡単に操作できるようにするラッパーです。
Webサービスは言わずもがな、AmazonとかTwitterとかGoogleとかのです。
APIにする理由は、
- 公開したくないから、一部の機能だけを操作可能にする窓口を公開する
- 複雑だから、簡単に操作可能にする窓口を公開する
などがあるかと思います。
前者は、APIの利用者が実装の詳細を触りたくても触れません。
後者は、必ずしも実装の詳細が隠されていません。
余談ですが、私がAPIでイメージするのは、すごく複雑な仕組みだけどボタンが3つくらいしかついていない機械、です。
投稿2014/08/22 15:28
総合スコア9390
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
0
シンプルな資料があまり無いので
Twitterを例にして口頭とホワイトボードで説明する事が多いです
TwitterAPIの例
・Twitterは外部のサーバ(サービス)だよねから説明スタート
・でも、別サイトにフィードとかいいねした人とか出してるのを見せる
・Twitterが持っている情報は自分達でも取得出来る事
・誰でも取得出来ちゃダメなので、認証するキーとかが必要
・DBにSQLで命令するのと同じように取得する構文がある
・DBを外部サービスに公開出来ないからHTTP通信で取れるようになってる
この辺りの説明をある程度理解してくれる子が殆どですが
実装者なら補足入れていきます
クライアント側
・PHPとかなら通信用にモジュールあるよ
・JSでも呼べるよ
・自分のデータとか、一般公開してるデータしか取れないよ
サーバー側
・認証(OAuthなど)しなきゃね
・データを返すフォーマットのJSON(など)にしてるよ
・負荷対策とかセキュリティ対策しなきゃね
で、必要な機能の概要を知ってもらい
今から実装するのはクライアントなのか?サーバーなのか?を理解させてから
実装に入ってもらうような流れにしています
あとは、APIとかよく使うシステムはサービスごとに規格バラバラだと皆困るから
RESTfulとかに合わせようねとか
投稿2014/08/22 13:39
総合スコア208
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
0
###ミドルウェアがプログラマ向けに提供する機能
というところですね。**「言語本来の機能ではなく、特定の環境下でしか動作しない。」**という但し書きが必要ですね。
投稿2016/10/02 12:32
総合スコア4830
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
0
APIの概念が分からないと人への説明ということでよかったでしょうか?
説明する相手のITリテラシーにもよると思いますが、仮にITリテラシー「低め」の方と想定した場合、身近なものに例えるとよいかと思いましたので、1例を。
「注文書を使うラーメン屋」と「APIを使うGoogle」の比較例
- ラーメン屋 = Google (サービス提供者)
- お客 = プログラマー (サービス利用者)
- 注文書= API (注文の申請書)
※イメージ
注文書「ラーメンの種類/麺の固さ/味の濃さ/油の量」
API「Google Map/地図に目印をつけたい/目印のアイコンを変えたい」
言葉でまとめると、
APIとは、「他者のサービスを利用するにあたり、サービス提供者が予め用意した注文書(書式)にそって注文し、希望のサービスを得る」というサービス授受工程の中の「注文書」みたいなもの。
みたいな説明ではどうでしょうか。
投稿2016/10/02 11:04
総合スコア64
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。
あなたの回答
tips
太字
斜体
打ち消し線
見出し
引用テキストの挿入
コードの挿入
リンクの挿入
リストの挿入
番号リストの挿入
表の挿入
水平線の挿入
プレビュー
質問の解決につながる回答をしましょう。 サンプルコードなど、より具体的な説明があると質問者の理解の助けになります。 また、読む側のことを考えた、分かりやすい文章を心がけましょう。
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。