ASP.NET Web API快速入門介紹
你可能也喜歡這些API文章!
REST 代表 Representational State Transfer，它是一組用于設計可擴展、統一和無狀態的 Web 服務的約束和指南。 REST 的一些主要原則是：
REST全稱是表述性狀態轉移，那究竟指的是什么的表述? 其實指的就是資源。任何事物，只要有被引用到的必要，它就是一個資源。
資源是任何可以通過 URI（統一資源標識符）標識的東西，例如用戶、產品、博客文章等。資源可以有不同的表示形式，例如 JSON、XML、HTML 等。例如，資源 https://example.com/users/1 可以表示為 JSON 對象：
{
"id": 1,
"name": "Alice",
"email": "alice@example.com"
}或者作為 XML 文檔：
<user>
<id>1</id>
<name>Alice</name>
<email>alice@example.com</email>
</user>或者作為 HTML 頁面：
<h1>User Profile</h1>
<p>ID: 1</p>
<p>Name: Alice</p>
<p>Email: alice@example.com</p>任何一個 RESTful Web 服務，創建時都至少需要做以下4部分工作：
第一步是確定您的 Web 服務將提供的資源并為它們分配有意義的 URI。例如，假設我們要創建一個用于管理博客文章的 Web 服務。您可以定義以下資源：
這里我們應該使用名詞來命名資源并避免使用動詞。還應該對集合使用復數形式，對單個資源使用單數形式。應該使用路徑參數 ( {id} ) 來標識集合中的特定資源。
下一步是使用適當的 HTTP 方法為每個資源實現邏輯。 HTTP 方法是：
例如，可以為 /posts 資源實現以下方法：
我們可以為其他資源實施類似的方法。您應該遵循 HTTP 約定并使用狀態代碼來指示每個請求的結果。例如：
下一步是處理 Web 服務的請求和響應格式。應該根據客戶的需要支持不同的格式。例如，可以支持 JSON、XML、HTML 等。也應該使用內容協商來根據請求的 Accept 標頭和響應的 Content-Type 標頭來確定要使用的格式。
例如，如果你想為你的網絡服務支持 JSON 和 XML 格式，你可以這樣寫：
// Get the accept header from the request
$accept = $_SERVER['HTTP_ACCEPT'];
// Set default format to JSON
$format = 'json';
// Check if XML format is requested
if (strpos($accept,'application/xml') !== false) {
// Set format to XML
$format = 'xml';
}
// Set content type header according to format
header('Content-Type: application/' . $format);
// Encode data according to format
if ($format == 'json') {
// Encode data as JSON
echo json_encode($data);
} else if ($format == 'xml') {
// Encode data as XML
echo xml_encode($data); // You need to implement this function yourself
}還應該根據客戶將數據發送到 Web 服務的方式來處理不同的請求格式。例如，您可以支持 JSON、XML、表單數據等。您應該再次使用內容協商來根據請求的 Content-Type 標頭來確定使用哪種格式。
// Get content type header from request
$content_type = $_SERVER['CONTENT_TYPE'];
// Set default format to JSON
$format = 'json';
// Check if XML format is sent
if (strpos($content_type,'application/xml') !== false) {
// Set format to XML
$format = 'xml';
}
// Decode data according to format
if ($format == 'json') {
// Decode data from JSON
$data = json_decode(file_get_contents('php://input'), true);
} else if ($format == 'xml') {
// Decode data from XML
$data = xml_decode(file_get_contents('php://input')); // You need to implement this function yourself
}當然，現代php開發都基于如Laravel這樣的知名框架來開發，在框架里面，這些請求格式，請求頭都非常容易獲取，一般都是通過使用中間件技術來實現
最后一步是處理處理請求時可能出現的任何錯誤和異常。您應該使用 try-catch 塊來捕獲您的代碼或外部庫可能拋出的任何異常。您還應該使用錯誤處理程序來捕獲可能由 PHP 本身觸發的任何錯誤。您應該在響應中返回有意義的錯誤消息和狀態代碼。
例如，您可以使用這樣的東西：
// Set error handler function
set_error_handler('error_handler');
// Define error handler function
function error_handler($errno, $errstr) {
// Log error message
error_log($errstr);
// Set status code header to 500 Internal Server Error
http_response_code(500);
// Return error message in JSON format
echo json_encode(['error' => $errstr]);
}
// Use try-catch block around your code
try {
// Your code here ...
} catch (Exception $e) {
// Log exception message
error_log($e->getMessage());
// Set status code header according to exception type
switch (get_class($e)) {
case 'InvalidArgumentException':
http_response_code(400);
break;
case 'UnauthorizedException':
http_response_code(401);
break;
case 'ForbiddenException':
http_response_code(403);
break;
case 'NotFoundException':
http_response_code(404);
break;
default:
http_response_code(500);
break;
}
// Return exception message in JSON format
echo json_encode(['error' => $e->getMessage()]);
}在現代php開發中，通過使用框架，使用框架中的自動異常捕獲技術，只需做一些簡單的配置，就可以輕松處理程序錯誤和運行時異常
在本文中，我們學習了如何使用 PHP 創建簡單的 RESTful Web 服務。學習了如何定義資源及其 URI、如何為每個資源實現 HTTP 方法、如何處理請求和響應格式以及如何處理錯誤和異常。還看到了一些說明這些概念的代碼示例。
使用 PHP 創建 RESTful Web 服務并不難，但需要注意細節和一些最佳實踐。在設計和實現 Web 服務時，應該始終遵循 REST 原則和 HTTP 約定。還應該做好 Web 服務的測試，感謝你的閱讀，希望本文能夠幫助到你！
文章轉自微信公眾號@老俊說技術
