The Project | About Us | Contribute | Donations | License

HOME

In this module, we will explore how to create and consume RESTful services using Delphi. RESTful services are a popular way to build web services that are lightweight, scalable, and easy to maintain. They use standard HTTP methods and can be consumed by a wide variety of clients, including web browsers, mobile apps, and other servers.

Key Concepts

REST (Representational State Transfer): An architectural style for designing networked applications.
HTTP Methods: Common methods include GET, POST, PUT, DELETE.
Endpoints: URLs that represent resources in the RESTful service.
JSON (JavaScript Object Notation): A lightweight data-interchange format often used in RESTful services.
HTTP Status Codes: Codes that indicate the result of the HTTP request (e.g., 200 OK, 404 Not Found).

Setting Up a RESTful Service in Delphi

Step 1: Create a New Delphi Project

Open Delphi and create a new project.
Select "File" > "New" > "Other" > "Delphi Projects" > "WebBroker Application".
Choose "Stand-alone VCL Application" and click "Next".
Click "Finish" to create the project.

Step 2: Define the RESTful Endpoints

Add a new unit to your project for the RESTful service logic.
Define the endpoints using TWebModule and TWebActionItem.

unit Unit1;

interface

uses
  System.SysUtils, System.Classes, Web.HTTPApp;

type
  TWebModule1 = class(TWebModule)
    procedure WebModule1DefaultHandlerAction(Sender: TObject; Request: TWebRequest; Response: TWebResponse; var Handled: Boolean);
    procedure WebModule1GetItemAction(Sender: TObject; Request: TWebRequest; Response: TWebResponse; var Handled: Boolean);
  private
    { Private declarations }
  public
    { Public declarations }
  end;

var
  WebModule1: TWebModule1;

implementation

{%CLASSGROUP 'Vcl.Controls.TControl'}

{$R *.dfm}

procedure TWebModule1.WebModule1DefaultHandlerAction(Sender: TObject; Request: TWebRequest; Response: TWebResponse; var Handled: Boolean);
begin
  Response.Content := 'Welcome to the RESTful Service!';
end;

procedure TWebModule1.WebModule1GetItemAction(Sender: TObject; Request: TWebRequest; Response: TWebResponse; var Handled: Boolean);
var
  ItemID: string;
begin
  ItemID := Request.QueryFields.Values['id'];
  if ItemID <> '' then
    Response.Content := Format('Item ID: %s', [ItemID])
  else
    Response.Content := 'Item ID not provided';
end;

end.

Step 3: Configure the WebModule

Open the WebModule1 unit in the designer.
Add two TWebActionItem components to the WebModule.
Set the PathInfo property of the first TWebActionItem to '/' and link it to WebModule1DefaultHandlerAction.
Set the PathInfo property of the second TWebActionItem to '/item' and link it to WebModule1GetItemAction.

Step 4: Run the RESTful Service

Run the project.
Open a web browser and navigate to http://localhost:8080/ to see the default handler response.
Navigate to http://localhost:8080/item?id=123 to see the item handler response.

Consuming RESTful Services

Step 1: Create a New Delphi Project

Open Delphi and create a new VCL Forms Application.

Step 2: Add Components to the Form

Add a TButton, TEdit, and TMemo to the form.
Set the TButton's Caption to "Get Item".
Set the TEdit's Text to "123".
Set the TMemo's Lines property to an empty string.

Step 3: Write the Code to Consume the RESTful Service

Add the System.Net.HttpClient unit to the uses clause.
Write the code to make an HTTP GET request to the RESTful service.

unit Unit1;

interface

uses
  System.SysUtils, System.Classes, Vcl.Controls, Vcl.Forms, Vcl.StdCtrls, System.Net.HttpClient;

type
  TForm1 = class(TForm)
    Button1: TButton;
    Edit1: TEdit;
    Memo1: TMemo;
    procedure Button1Click(Sender: TObject);
  private
    { Private declarations }
  public
    { Public declarations }
  end;

var
  Form1: TForm1;

implementation

{$R *.dfm}

procedure TForm1.Button1Click(Sender: TObject);
var
  HttpClient: THttpClient;
  Response: IHTTPResponse;
  URL: string;
begin
  HttpClient := THttpClient.Create;
  try
    URL := Format('http://localhost:8080/item?id=%s', [Edit1.Text]);
    Response := HttpClient.Get(URL);
    Memo1.Lines.Text := Response.ContentAsString();
  finally
    HttpClient.Free;
  end;
end;

end.

Step 4: Run the Client Application

Run the project.
Click the "Get Item" button to make a request to the RESTful service and display the response in the TMemo.

Practical Exercises

Exercise 1: Add a New Endpoint

Add a new endpoint to the RESTful service that returns a list of items in JSON format.
Update the client application to consume this new endpoint and display the list of items.

Solution

Add the new endpoint to the WebModule.

procedure TWebModule1.WebModule1GetItemsAction(Sender: TObject; Request: TWebRequest; Response: TWebResponse; var Handled: Boolean);
begin
  Response.ContentType := 'application/json';
  Response.Content := '[{"id":1,"name":"Item 1"},{"id":2,"name":"Item 2"}]';
end;

Update the client application to consume the new endpoint.

procedure TForm1.Button1Click(Sender: TObject);
var
  HttpClient: THttpClient;
  Response: IHTTPResponse;
  URL: string;
begin
  HttpClient := THttpClient.Create;
  try
    URL := 'http://localhost:8080/items';
    Response := HttpClient.Get(URL);
    Memo1.Lines.Text := Response.ContentAsString();
  finally
    HttpClient.Free;
  end;
end;

Common Mistakes and Tips

Common Mistake: Forgetting to set the ContentType of the response to 'application/json' when returning JSON data.
- Tip: Always set the appropriate ContentType for the response to ensure the client interprets the data correctly.
Common Mistake: Not handling exceptions in the client application.
- Tip: Use try-except blocks to handle exceptions and provide meaningful error messages to the user.

Conclusion

In this module, we have learned how to create and consume RESTful services using Delphi. We covered the basics of setting up a RESTful service, defining endpoints, and making HTTP requests from a client application. By completing the practical exercises, you should now have a solid understanding of how to work with RESTful services in Delphi. In the next module, we will explore mobile development with Delphi, building on the skills we have learned so far.

RESTful Services

Key Concepts

Setting Up a RESTful Service in Delphi

Step 1: Create a New Delphi Project

Step 2: Define the RESTful Endpoints

Step 3: Configure the WebModule

Step 4: Run the RESTful Service

Consuming RESTful Services

Step 1: Create a New Delphi Project

Step 2: Add Components to the Form

Step 3: Write the Code to Consume the RESTful Service

Step 4: Run the Client Application

Practical Exercises

Exercise 1: Add a New Endpoint

Solution

Common Mistakes and Tips

Conclusion

Delphi/Object Pascal Programming Course

Module 1: Introduction to Delphi/Object Pascal

Module 2: Control Structures and Procedures

Module 3: Working with Data

Module 4: Object-Oriented Programming

Module 5: Advanced Delphi Features

Module 6: GUI Development with VCL and FMX

Module 7: Web and Mobile Development

Module 8: Best Practices and Design Patterns

Module 9: Final Project