Delphi中怎么调用WebApi

在现代软件开发中，Web API（Application Programming Interface）已经成为不同系统之间进行数据交换和通信的重要方式。Delphi作为一种强大的编程语言，提供了多种方式来调用Web API。本文将详细介绍如何在Delphi中调用Web API，包括使用REST.Client、IdHTTP、THTTPClient等组件，以及如何处理JSON数据。

1. 使用REST.Client组件调用Web API

REST.Client是Delphi中用于调用RESTful Web API的组件。它提供了简单易用的接口，可以方便地发送HTTP请求并处理响应。

1.1 创建REST客户端

首先，在Delphi的表单上放置一个TRESTClient、一个TRESTRequest和一个TRESTResponse组件。这些组件可以在REST Client组件面板中找到。

var
  RESTClient: TRESTClient;
  RESTRequest: TRESTRequest;
  RESTResponse: TRESTResponse;
begin
  RESTClient := TRESTClient.Create(nil);
  RESTRequest := TRESTRequest.Create(nil);
  RESTResponse := TRESTResponse.Create(nil);

  try
    RESTClient.BaseURL := 'https://api.example.com';
    RESTRequest.Client := RESTClient;
    RESTRequest.Response := RESTResponse;
    RESTRequest.Method := rmGET;
    RESTRequest.Resource := 'users';

    RESTRequest.Execute;

    if RESTResponse.StatusCode = 200 then
    begin
      ShowMessage(RESTResponse.Content);
    end
    else
    begin
      ShowMessage('Error: ' + RESTResponse.StatusText);
    end;
  finally
    RESTClient.Free;
    RESTRequest.Free;
    RESTResponse.Free;
  end;
end;

1.2 处理JSON响应

Web API通常返回JSON格式的数据。Delphi提供了System.JSON单元来处理JSON数据。

uses
  System.JSON;

var
  JSONValue: TJSONValue;
  JSONObject: TJSONObject;
  JSONArray: TJSONArray;
  i: Integer;
begin
  JSONValue := TJSONObject.ParseJSONValue(RESTResponse.Content);
  try
    if JSONValue is TJSONArray then
    begin
      JSONArray := JSONValue as TJSONArray;
      for i := 0 to JSONArray.Count - 1 do
      begin
        JSONObject := JSONArray.Items[i] as TJSONObject;
        ShowMessage(JSONObject.GetValue('name').Value);
      end;
    end
    else if JSONValue is TJSONObject then
    begin
      JSONObject := JSONValue as TJSONObject;
      ShowMessage(JSONObject.GetValue('name').Value);
    end;
  finally
    JSONValue.Free;
  end;
end;

2. 使用IdHTTP组件调用Web API

IdHTTP是Indy库中的一个组件，用于发送HTTP请求。它比REST.Client更底层，提供了更多的灵活性。

2.1 发送GET请求

uses
  IdHTTP, IdSSLOpenSSL;

var
  IdHTTP: TIdHTTP;
  Response: string;
begin
  IdHTTP := TIdHTTP.Create(nil);
  try
    IdHTTP.Request.ContentType := 'application/json';
    IdHTTP.Request.Accept := 'application/json';
    IdHTTP.HTTPOptions := [hoForceEncodeParams];

    Response := IdHTTP.Get('https://api.example.com/users');
    ShowMessage(Response);
  finally
    IdHTTP.Free;
  end;
end;

2.2 发送POST请求

var
  IdHTTP: TIdHTTP;
  Response: string;
  RequestBody: TStringStream;
begin
  IdHTTP := TIdHTTP.Create(nil);
  RequestBody := TStringStream.Create('{"name": "John Doe"}', TEncoding.UTF8);
  try
    IdHTTP.Request.ContentType := 'application/json';
    IdHTTP.Request.Accept := 'application/json';
    IdHTTP.HTTPOptions := [hoForceEncodeParams];

    Response := IdHTTP.Post('https://api.example.com/users', RequestBody);
    ShowMessage(Response);
  finally
    IdHTTP.Free;
    RequestBody.Free;
  end;
end;

2.3 处理JSON响应

与REST.Client类似，可以使用System.JSON单元来处理JSON数据。

var
  JSONValue: TJSONValue;
  JSONObject: TJSONObject;
  JSONArray: TJSONArray;
  i: Integer;
begin
  JSONValue := TJSONObject.ParseJSONValue(Response);
  try
    if JSONValue is TJSONArray then
    begin
      JSONArray := JSONValue as TJSONArray;
      for i := 0 to JSONArray.Count - 1 do
      begin
        JSONObject := JSONArray.Items[i] as TJSONObject;
        ShowMessage(JSONObject.GetValue('name').Value);
      end;
    end
    else if JSONValue is TJSONObject then
    begin
      JSONObject := JSONValue as TJSONObject;
      ShowMessage(JSONObject.GetValue('name').Value);
    end;
  finally
    JSONValue.Free;
  end;
end;

3. 使用THTTPClient组件调用Web API

THTTPClient是Delphi XE8及更高版本中引入的组件，用于发送HTTP请求。它提供了更现代的API，支持异步操作。

3.1 发送GET请求

uses
  System.Net.HttpClient;

var
  HTTPClient: THTTPClient;
  Response: IHTTPResponse;
begin
  HTTPClient := THTTPClient.Create;
  try
    Response := HTTPClient.Get('https://api.example.com/users');
    if Response.StatusCode = 200 then
    begin
      ShowMessage(Response.ContentAsString);
    end
    else
    begin
      ShowMessage('Error: ' + Response.StatusText);
    end;
  finally
    HTTPClient.Free;
  end;
end;

3.2 发送POST请求

var
  HTTPClient: THTTPClient;
  Response: IHTTPResponse;
  RequestBody: TStringStream;
begin
  HTTPClient := THTTPClient.Create;
  RequestBody := TStringStream.Create('{"name": "John Doe"}', TEncoding.UTF8);
  try
    Response := HTTPClient.Post('https://api.example.com/users', RequestBody);
    if Response.StatusCode = 200 then
    begin
      ShowMessage(Response.ContentAsString);
    end
    else
    begin
      ShowMessage('Error: ' + Response.StatusText);
    end;
  finally
    HTTPClient.Free;
    RequestBody.Free;
  end;
end;

3.3 处理JSON响应

同样，可以使用System.JSON单元来处理JSON数据。

var
  JSONValue: TJSONValue;
  JSONObject: TJSONObject;
  JSONArray: TJSONArray;
  i: Integer;
begin
  JSONValue := TJSONObject.ParseJSONValue(Response.ContentAsString);
  try
    if JSONValue is TJSONArray then
    begin
      JSONArray := JSONValue as TJSONArray;
      for i := 0 to JSONArray.Count - 1 do
      begin
        JSONObject := JSONArray.Items[i] as TJSONObject;
        ShowMessage(JSONObject.GetValue('name').Value);
      end;
    end
    else if JSONValue is TJSONObject then
    begin
      JSONObject := JSONValue as TJSONObject;
      ShowMessage(JSONObject.GetValue('name').Value);
    end;
  finally
    JSONValue.Free;
  end;
end;

4. 处理异常

在调用Web API时，可能会遇到各种异常情况，如网络错误、服务器错误等。因此，处理异常是非常重要的。

try
  Response := HTTPClient.Get('https://api.example.com/users');
  if Response.StatusCode = 200 then
  begin
    ShowMessage(Response.ContentAsString);
  end
  else
  begin
    ShowMessage('Error: ' + Response.StatusText);
  end;
except
  on E: Exception do
  begin
    ShowMessage('Exception: ' + E.Message);
  end;
end;

5. 总结

在Delphi中调用Web API有多种方式，每种方式都有其优缺点。REST.Client组件提供了简单易用的接口，适合快速开发；IdHTTP组件提供了更多的灵活性，适合需要更底层控制的场景；THTTPClient组件则提供了更现代的API，支持异步操作。无论选择哪种方式，处理JSON数据和异常都是必不可少的步骤。希望本文能帮助你在Delphi中成功调用Web API。