WebAPIについてのメモ

2020年5月27日

Web API (Web Application Programming Interface )

HTTPプロトコルを用いてネットワーク越しに呼び出すアプリケーション間、システム間のインターフェースのこと。

外部Webサービスの窓口である

PythonでTwitterAPIを利用することもできる

Web APIの種類

  • XML-RPC XML Remote Procedure Call)
    XMLベース。
  • SOAP Simple Object Access Protocol
    初期のころ、いまはほぼない。XMLベースのプロトコル。
  • REST Representational State Transfer
    主流。RESTの考え方に従って実装されたAPIをRESTful API(またはREST API)と呼ぶ。

HTTPプロトコル

  • GET
    リソースの取得(GETでのアクセスはリソースの内容に影響を与えない)
  • POST
    リソースの新規作成
  • PUT
    既存のリソースのアップデート
  • DELETE
    リソースの削除

CRUD

Create POST
Read GET
Update PUT
Delete DELETE

URL

1つのURLでアクションが複数ある

例えばログインページ、ログインページくれはGET、ログインするはPOSTのアクション

リクエストURL、エンドポイント(URI)ともいう

https://qiita.com/NagaokaKenichi/items/6298eb8960570c7ad2e9

リクエストパラメーター

URLに&で区切ることが可能

URLエンコーディング

日本語特有、日本語の場合はパーセントエンコーディングすうr

リクエストヘッダーと認証

WEB-APIを利用するパスワード。アクセストークン。

リクストボディ

パラメーターを含めれる。

APIドキュメントの読み方

必ずAPIのドキュメントがある。

curl httpのリクエストをおくるシェルコマンド

APIラッパー

プログラムごとに使い方のコードがある

APIのテスト

Chromeの拡張Talend API Tester

旧名Restlet Client

Swagger

Swagger は RESTful APIを構築するためのオープンソースのフレームワーク

PyhtonでWebAPIをたたく例

System

Posted by zzz