第6章 · 自動化とプログラマビリティ·v1.0.0·更新 2026/7/17·読了目安 約16分
変更要約: 初版
6.3REST APIとデータ形式
この節の要点
コントローラや機器を自動化から操作する土台となるREST APIの性質（ステートレス・HTTP上で動く）、CRUD操作とHTTPメソッド（POST/GET/PUT/DELETE）の対応、成否を示すHTTPステータスコード（200/201/4xx/5xx）、そしてデータ交換の主役JSON（{}オブジェクト・[]配列・キーと値・データ型）の読み取りを、実務の観点から学びます。
前の節のコントローラを「スクリプトから操作する」その入口がREST APIです。REST APIは私たちが普段ブラウザで使っているHTTPの仕組みをそのまま流用し、機器の状態を「取得（GET）」「作成（POST）」「更新（PUT）」「削除（DELETE）」します。そしてやり取りされるデータの大半はJSONという軽量な形式です。この節では、REST APIの基本的な作法と、返ってきたJSONを正しく読み取る力を、CLIの代わりにAPIで運用する実務の視点から身につけます。
6.3.1REST APIの性質とCRUD/HTTPメソッド
- REST API＝HTTP上でリソース（機器・設定・状態）をURLで指し示し、HTTPメソッドで操作するAPIスタイル。ステートレス＝サーバはリクエスト間でクライアントのセッション状態を保持せず、各リクエストが自己完結して必要情報（認証トークン等）を都度含む。
- CRUD（Create/Read/Update/Delete）はHTTPメソッドに対応する＝作成=POST／取得=GET／更新=PUT（部分更新はPATCH）／削除=DELETE。例：
GET /api/v1/interfacesは全インタフェースの状態取得、POST /api/v1/vlansは新規VLAN作成。 - リクエストにはヘッダ（
Content-Type: application/json・認証トークン等）と、作成/更新時はボディ（JSON等のペイロード）を付ける。GETは通常ボディを持たずURLで対象を指定する。