HTTP メソッドの概要
RESTful Web サービスを操作する場合、HTTP メソッド、特に POST と PUT の違いを理解することが重要です。これらのメソッドはリソースの作成と更新によく使用されますが、動作方法は異なります。それらの固有の目的と適切なアプリケーションを理解することは、API 設計が効率的で直観的であることを保証するのに役立ちます。
通常、POST は新しいリソースの作成に使用され、PUT は特定の URI でリソースを作成または置換するために使用されます。この違いは微妙ではありますが、Web サービス環境でのリソースの管理方法と対話方法に重要な意味を持ちます。
指示 | 説明 |
---|---|
express() | Express アプリケーションを初期化します。 |
app.use(express.json()) | 受信した JSON リクエストを解析するミドルウェア。 |
app.post() | リソースの作成を処理する POST ルートを定義します。 |
app.put() | リソースの更新または置換を処理するための PUT ルートを定義します。 |
req.body | リクエスト本文で送信された JSON データにアクセスします。 |
res.status().send() | HTTPステータスコードを設定し、クライアントに応答を送信します。 |
fetch() | フロントエンドからHTTPリクエストを実行します。 |
method: 'POST' | フェッチリクエストで使用するHTTPメソッドを指定します。 |
headers: { 'Content-Type': 'application/json' } | JSON コンテンツを示すようにリクエスト ヘッダーを設定します。 |
body: JSON.stringify(data) | JavaScript オブジェクト データをリクエスト本文の JSON 文字列に変換します。 |
POST スクリプトと PUT スクリプトの機能を理解する
Node.js と Express を使用したバックエンド スクリプトは、HTTP メソッドの処理方法を示します。 POST そして PUT リソース管理用。の express() 関数は Express アプリケーションを初期化します。 app.use(express.json()) ミドルウェアは、受信した JSON リクエストを解析するために使用されます。の app.post() メソッドは、リソース データが抽出されるリソースを作成するルートを定義します。 req.body そしてサーバー側のオブジェクトに保存されます。応答は、リソースが正常に作成されたことを示す 201 ステータス コードとともにクライアントに返されます。
の app.put() メソッドは、既存のリソースを更新または置換するルートを定義します。このメソッドは、次のリソース ID を使用します。 req.params.id そしてからのデータ req.body サーバー側オブジェクトを更新します。応答はステータス コード 200 とともに返され、リソースが正常に更新されたことを示します。フロントエンド スクリプトは、Fetch API を使用してこれらの HTTP リクエストを実行します。の fetch() 関数は適切なメソッドで使用されます (POST そして PUT) とヘッダーを使用してバックエンドと対話し、リソースがクライアント側から正しく作成および更新されるようにします。
Node.js と Express を使用したバックエンド スクリプト
このスクリプトは、Node.js および Express バックエンドで POST および PUT メソッドを使用する方法を示します。
const express = require('express');
const app = express();
app.use(express.json());
let resources = {};
app.post('/resource', (req, res) => {
const id = generateId();
resources[id] = req.body;
res.status(201).send({ id, ...req.body });
});
app.put('/resource/:id', (req, res) => {
const id = req.params.id;
resources[id] = req.body;
res.status(200).send({ id, ...req.body });
});
function generateId() {
return Math.random().toString(36).substr(2, 9);
}
app.listen(3000, () => {
console.log('Server is running on port 3000');
});
JavaScript と Fetch API を使用したフロントエンド スクリプト
このスクリプトは、JavaScript と Fetch API を使用してフロントエンド アプリケーションから POST リクエストと PUT リクエストを行う方法を示します。
const createResource = async (data) => {
const response = await fetch('http://localhost:3000/resource', {
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
});
return response.json();
};
const updateResource = async (id, data) => {
const response = await fetch(`http://localhost:3000/resource/${id}`, {
method: 'PUT',
headers: {
'Content-Type': 'application/json'
},
body: JSON.stringify(data)
});
return response.json();
};
// Example usage
createResource({ name: 'New Resource' }).then(data => console.log(data));
updateResource('existing-id', { name: 'Updated Resource' }).then(data => console.log(data));
RESTful API でのリソース作成の探索
RESTful API を設計する場合、次のいずれかを選択します。 POST そして PUT リソース作成の方法は、ユースケースと望ましい動作によって異なります。の POST メソッドは、指定されたリソースの下に新しい従属リソースを作成するために使用されます。これは冪等ではありません。つまり、複数の同一の POST リクエストにより複数のリソースが作成されます。この方法は、サーバーが新しいリソースの URI を決定する場合に最適です。
一方、 PUT メソッドは、特定の URI でリソースを作成または置換できます。これは冪等であり、複数の同一の PUT リクエストが 1 つのリクエストと同じ結果を生成することを意味します。このメソッドは、クライアントが作成または更新するリソースの URI を指定するシナリオに適しています。これらの違いを理解すると、予想される動作や要件に合わせた API を設計するのに役立ちます。
HTTP での POST および PUT に関するよくある質問
- POST メソッドの主な用途は何ですか?
- の POST メソッドは主に、指定されたリソースの下位として新しいリソースを作成するために使用されます。
- PUT メソッドの主な用途は何ですか?
- の PUT メソッドは、特定の URI でリソースを作成または置換するために使用されます。
- POSTはべき等ですか?
- いいえ、 POST メソッドは冪等ではありません。つまり、複数の同一の POST リクエストによって複数のリソースが作成されます。
- PUT は冪等ですか?
- はい PUT メソッドはべき等です。つまり、複数の同一の PUT リクエストは 1 つのリクエストと同じ結果を生成します。
- PUT ではなく POST を使用する必要があるのはどのような場合ですか?
- 使用 POST サーバーが新しいリソースの URI を決定し、クライアントがそれを指定する必要がない場合。
- POST ではなく PUT を使用する必要があるのはどのような場合ですか?
- 使用 PUT クライアントが作成または更新するリソースの URI を指定する場合。
- PUT を使用してリソースを更新できますか?
- はい PUT 指定された URI が既存のリソースを参照している場合、メソッドは既存のリソースを更新できます。
- POST を使用してリソースを更新できますか?
- その間 POST 技術的にはリソースを更新できますが、通常は新しいリソースを作成するために使用されます。
- PUT リクエストの URI が存在しない場合はどうなりますか?
- URI が存在しない場合、 PUT メソッドは、その URI に新しいリソースを作成できます。
- 成功した POST リクエストの応答ステータス コードは何ですか?
- 成功しました POST 通常、リクエストは 201 Created ステータス コードを返します。
HTTP での POST と PUT の重要なポイント
効率的かつ効果的な RESTful API を構築するには、リソース作成に適切な HTTP メソッドを選択することが不可欠です。の POST このメソッドは、サーバーがリソースの URI を決定する新しいリソースの作成に最適です。これはべき等ではありません。つまり、複数のリクエストにより複数のリソースが作成される可能性があります。対照的に、 PUT このメソッドは、クライアントがリソースの URI を指定する場合に最適で、リソースの作成または更新に使用できます。これはべき等であり、リクエストが繰り返し行われた場合でも一貫した結果が保証されます。
これらの微妙な違いを理解することは、開発者が予想される動作や要件に合わせた API を設計するのに役立ちます。提供されている例は、Node.js と Express を使用してバックエンド システムにこれらのメソッドを実装し、サーバー側とクライアント側の両方からリソースが効果的に管理されるようにする方法を示しています。
POST メソッドと PUT メソッドに関する最終的な考え方
結論として、POST メソッドと PUT メソッドは両方とも、RESTful API 内でのリソースの作成と管理において異なる役割を持っています。 POST は、URI を指定せずに新しいリソースを作成する場合に最適ですが、PUT は、指定した URI でリソースを作成または更新する場合に適しています。これらのメソッドを理解し、適切に使用することで、開発者は堅牢で信頼性が高く、RESTful アーキテクチャの原則に沿った API を設計できます。