📘

誰でも分かる HTTP の基本と確認方法

2024/06/04に公開

はじめに

最近、情シスの方から問い合わせを受けることが多いのですが、必要な情報が不足していることが多いため、この記事を作成しました。

HTTP(Hypertext Transfer Protocol)は、ウェブ上でデータをやり取りするためのプロトコルです。エンジニアが情シスからの問い合わせに対応する際、以下の情報が重要です。

欲しい情報

URL

URL(Uniform Resource Locator)は、リクエストを送る先のアドレスです。例えば、https://example.com/api/resource のような形式です。

メソッド

HTTP メソッドは、リクエストがどのようなアクションを行うかを指定します。一般的なメソッドには以下があります:

  • GET: データの取得
  • POST: 新しいデータの作成
  • PUT: 既存データの更新
  • DELETE: データの削除

リクエストボディ

リクエストボディは、POST や PUT メソッドの際にサーバーに送信するデータです。通常、JSON 形式や XML 形式で送信されます。例:

{
  "name": "John Doe",
  "email": "john@example.com"
}

レスポンスコード

レスポンスコードは、サーバーからのレスポンスのステータスを示します。よく使われるコードは以下の通りです:

  • 200 OK: リクエストが成功した
  • 201 Created: 新しいリソースが作成された
  • 400 Bad Request: リクエストが不正である
  • 401 Unauthorized: 認証が必要である
  • 404 Not Found: リクエストしたリソースが見つからない
  • 500 Internal Server Error: サーバー側のエラー

レスポンスボディ

レスポンスボディは、サーバーから返されるデータです。これも通常は JSON や XML 形式です。例:

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com"
}

確認する方法

  1. ブラウザの開発者ツールを使用する
  • Chrome や Firefox などのブラウザには開発者ツールが内蔵されています。これを使用して、ネットワークタブから HTTP リクエストとレスポンスを確認できます。
  • 開発者ツールを開くには、F12 キーを押すか、右クリックして「検証」を選びます。
  1. cURL を使用する
  • cURL はコマンドラインから HTTP リクエストを送信するためのツールです。以下のように使用します:
curl -X GET https://example.com/api/resource
curl -X POST https://example.com/api/resource -d '{"name":"John Doe"}' -H "Content-Type: application/json"

  1. Postman を使用する
  • Postman(https://www.postman.com/) は GUI ベースの HTTP クライアントで、複雑なリクエストを簡単に作成し、レスポンスを確認できます。

これらの情報と方法を使用すれば、エンジニアは HTTP リクエストとレスポンスの詳細を迅速かつ正確に確認できます。

報告のフォーマット例

以下の内容でメールをくれるとありがたいです。

  • 操作方法
  • URL
  • メソッド
  • リクエストボディ
  • レスポンスボディ
  • レスポンスコード

まとめ

以上の内容を意識してエンジニアに情報を提供していただければ、エンジニアはスムーズに対応することができます。適切な情報を提供することで、迅速かつ正確な問題解決が可能となりますので、どうぞご協力をよろしくお願いいたします。

Discussion