0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

WebAPI 備忘録的につらつらと

Posted at

良い記事見つけたので自分用に補足やら省いたりやらなんやらして書いてく
内容はほぼ以下と一緒なので、ちゃんと勉強したい人はそっちを見るべき

知識

事前知識

アプリケーションの種類

  • スタンドアロン
    • ほかの危機に依存せず単独で動作するアプリケーション
  • クライアントサーバ
    • 前回の記事参照

サーバとクライアント

  これも前回記事に書いてるので省略

Webブラウジング

Webブラウジングとはインターネットでサイトを見る事
Webブラウジングもクライアントサーバ型。
クライアントであるブラウザがWebサーバにhttpで通信してコンテンツを表示する。
「http」は後述

http(プロトコル)とは

英語的にいうと、HyperText Transfer Protocolの略。HyperTextはhtml(HyperText Markup Language)の事と思えば良い。

単にhttpという時と、httpプロトコルっていう時がある。

インターネット上でWebサーバー(サイトの公開側)と、クライアント(ブラウザ:サイトを閲覧する側)が、相互に通信するために使用される仕組みです。

もっと言うと、Webサーバーとクライアント間で、HTML(Webページを作成するための言語)で記載された情報をやりとりするための仕組みです。

by ゆとり世代のブログ運営論
参考HTTPプロトコルの紹介

httpのポイント

大きく分けてリクエストとレスポンスがある。
日本語でいうと要求と反応。

リクエスト(要求)

別な言い方をすると注文。クライアントからサーバに送る。
よくあるのはデータが欲しいとか、データを保存してとかをリクエストする
以下リクエストの中身。

  • url
  • メソッド
    • GET:サーバへデータの要求
    • POST:サーバへデータを送る
    • 他にもPUT、DELETEとかあるよ

レスポンス(反応)

別な言い方をすると結果。リクエスト受けたサーバがクライアントに返す。
リクエストされたデータの中身とか、登録した結果など。
以下レスポンスの中身。

  • ステータスコード(成否とかを数字で表現している)
    • 200:成功
    • 400:リクエストが不正
    • 500:サーバのエラー
  • コンテンツ(html)

APIとは

簡単な例えでいうと、プログラムの関数のようなもの。
は?どゆこと?

APIは「Application Program Interface」の略で簡単に説明すると、どのアプリーケーションでも共通で使える機能を提供する仕組みです。
by SoftBank スマートフォン サービス開発支援サイト

ふむふむ

APIは「Application Programming Interface」の略です。アプリケーションプログラミングインターフェイス。
 例えば「AというファイルをBという名前でコピーをして、作業完了したら、ポップアップウィンドウを出して知らせる!」というプログラムを作るとします。実際にどんな動きをするのかパートに分けてみると……、

Aというファイルを選択
実行ボタンを押すと3のステップへ
データをコピーする
コピーされたデータをBという名前を付け保存
ポップアップウィンドウを出して作業完了を告げる
 この1.〜5.の作業をすべて一から作成すると、かなり手間が掛かります(マウスの動きを計算して、ウィンドウのデザインを考えて……)。そこで登場するのがAPIです。

ファイルを選択するAPI
ボタンを押すとプログラムを動かすAPI
データをコピーするAPI
ファイルに名前を付けるAPI
ウィンドウを出してメッセージを出すAPI
と、いろいろな機能があるAPIから、必要なAPIを探し出し組み合わせるだけで、プログラムができてしまうのです。つまりAPIは「特定の機能を持つプログラム部品」なのです。よく使われる命令をAPIにしてみんなで共有してしまえば、非常に効率的に作業ができますね。

API
image.png
図1 APIを使えば、細かい作業や無駄を省いてプログラムができる

https://atmarkit.itmedia.co.jp/ait/articles/0703/13/news095.html

あー
共通利用できる関数って認識か
ほんまに関数やな

WebAPI

ネットワーク越しに利用できる関数。URLが関数名で引数を渡す事で結果が変化する。

どゆこと?

詳しく

コンピュータプログラムの提供する機能を外部の別のプログラムから呼び出して利用するための手順・規約(API:Application Programming Interface)の類型の一つで、HTTPなどWebの技術を用いて構築されたもののこと。
Webサイトに外部のサイトの提供する機能や情報を組み込んだり、アプリケーションソフトからWeb上で公開されている機能や情報を利用する際などに用いられる。
Web APIで機能を公開しているサーバに対して、インターネットなどの通信ネットワークを通じて依頼内容をHTTPリクエストの形で送信すると、処理結果がHTTPレスポンスの形で送られてくる。送受信されるデータの形式はAPIによって様々だが、Webでよく用いられるXMLやHTML、JSON、各種の画像ファイル形式などが用いられることが多い。
by IT用語辞典

別な切り口で

Web APIとは、ひとことで言えば、インターネット(Web)を経由して、何らかの処理を行うための、手段や決めごと(API)のことです。APIとは、Application Program Interfaceの略で、直訳すると、あるプログラムを、他のアプリケーションから利用するためのインターフェース、という意味になります。
 一般的なプログラムでは、関数やサブルーチンと呼ばれるひとかたまりの処理を作成し、それをプログラム内のほかの場所から呼び出すことができます。Web APIを利用すると、それと同じような感覚で、インターネット経由で別のサーバー上にあるプログラムを呼び出し、その結果を受け取ることができるようになります。
by CodeZine

WebAPI→http通信でリクエストしてレスポンスを貰う。
サーバからなんか呼び出して受け取る。

WebAPIの一旦のまとめ

  • サーバーで用意している関数(機能)をhttpで通信して利用する事。
  • 利用するには決め事を守ってリクエストを出す。
  • 決まり事とはURLとか渡すデータの名前とかデータの形式とか
  • レスポンスは大体何かしらのデータ。時々画像も。
  • データの形式は最近はJSON。一昔前はXMLが主流だった。
  • ajax形式で利用される事が多い
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?