フリーランス 技術調査ブログ

フリーランス/エンジニア Ruby Python Nodejs Vuejs React Dockerなどの調査技術調査の備忘録

WebAPI設計関連について調べる

API の価値を生み出す 4 つの方法 (google)

cloud.google.com

API公開の効果と課題 (総務省

www.soumu.go.jp

綺麗なAPIを設計するには気をつけたい5つのポイント(NTTデータ)

developer.ntt.com

Best Practices for Designing a Pragmatic RESTful API

www.vinaysahni.com

Best Practices in API Design (swagger)

swagger.io

HTTP/HTTPS通信のキャプチャツール Fiddlerをインストールする

  • 下記のサイトからダウンロードする。使い方がなれていないので、後で覚える

www.telerik.com

f:id:PX-WING:20201129012557p:plain

メソッドの種類

  • 全部で8種類 | # | メソッド | 概要 | | --- | --- | --- | | 1 | OPTIONS | サーバー側が提供する機能の確認 | | 2 | GET | リソースの取得 | | 3 | HEAD | リソースのヘッダー取得 | | 4 | POST | 従属リソースの作成 | | 5 | PUT | 新規リソースの作成、リソースの更新 | | 6 | DELETE | リソースの削除 | | 7 | TRACE | 通信経路の確認 | | 8 | CONNECT | プロキシのトンネル接続 |

CRUDで主に利用するメソッド

操作 メソッド
Create 作成 POST / PUT
Read 読み取り GET
Update 更新 PUT
Delete 削除 DELETE

HTTPステータスコード

ステータスコード 分類 意味
1xx Informational リクエストは請けいられたので処理を継続
2xx Success リクエストが受け入れられて正常処理された
3xx Redirection リクエスト完了のために追加操作が必要
4xx Client Error リクエストに誤りがある
5xx Server Error サーバー処理失敗