Podejście REST (Representational State Transfer) i RPC (Remote Procedure Call) to dwa różne podejścia do tworzenia interfejsów API w kontekście aplikacji webowych. Oto porównanie tych dwóch podejść:

Architektura i filozofia:
- REST (Representational State Transfer): Jest to architektura oparta na zasobach (resources) i operacjach na tych zasobach. REST promuje zasady takie jak jednolity interfejs, bezstanowość, klient-serwer oraz zasób jako reprezentacja stanu. REST opiera się na standardowych metodach HTTP, takich jak GET, POST, PUT i DELETE, do zarządzania zasobami.
- RPC (Remote Procedure Call): Jest to podejście oparte na wywoływaniu zdalnych procedur. W RPC klient wywołuje zdalne metody lub funkcje na serwerze, a serwer zwraca wyniki tych wywołań. Nie ma konieczności myślenia o zasobach ani ich reprezentacji. RPC jest często stosowane w przypadku zdalnych wywołań metod w językach programowania.
Interfejs i URI:
- REST: W REST, zasoby są reprezentowane jako URI (Uniform Resource Identifier), a operacje na tych zasobach są wykonywane za pomocą standardowych metod HTTP. Na przykład, GET /products może być używane do pobrania listy produktów.
- RPC: W RPC, klient wywołuje zdalne metody, które są identyfikowane przez nazwy funkcji lub metod, a nie przez URI. Nie ma konieczności konstruowania adresów URI dla operacji.
Format danych:
- REST: W REST często używa się formatów danych takich jak JSON lub XML do reprezentacji zasobów i przesyłania informacji między klientem a serwerem.
- RPC: W RPC dane są przesyłane jako parametry wywołania metody i odpowiedzi. Format danych może być bardziej zróżnicowany, w zależności od stosowanego protokołu.
Zarządzanie stanem:
- REST: REST promuje bezstanowość, co oznacza, że każde żądanie musi zawierać wszystkie potrzebne informacje do przetworzenia. Serwer nie przechowuje stanu klienta między żądaniami.
- RPC: RPC może być zarówno bezstanowe, jak i stanowe, w zależności od implementacji. Może zachować stan między wywołaniami, co może być przydatne w niektórych przypadkach.
Przykłady:
- REST: Przykładem REST API może być interfejs API dla sklepu internetowego, w którym zasoby to produkty, a operacje to pobieranie listy produktów, dodawanie produktów do koszyka itp.
- RPC: Przykładem RPC może być zdalne wywołanie metody, np. zdalne wywołanie metody obliczającej sumę dwóch liczb.

Podsumowując, REST i RPC to różne podejścia do projektowania interfejsów API, z różnymi filozofiami i cechami. REST jest bardziej oparty na zasobach i operacjach na nich, podczas gdy RPC skupia się na wywoływaniu zdalnych procedur. Wybór między nimi zależy od konkretnych potrzeb projektu i preferencji dewelopera.

Przykłady

RESTful API:

Przykład RESTful API dla zarządzania listą zadań:

Kontroler i akcje:

[Route("api/[controller]")]
[ApiController]
public class TasksController : ControllerBase
{
    private readonly ITaskService _taskService;

    public TasksController(ITaskService taskService)
    {
        _taskService = taskService;
    }

    [HttpGet]
    public IActionResult GetAllTasks()
    {
        var tasks = _taskService.GetAllTasks();
        return Ok(tasks);
    }

    [HttpGet("{id}")]
    public IActionResult GetTaskById(int id)
    {
        var task = _taskService.GetTaskById(id);
        if (task == null)
            return NotFound();
        return Ok(task);
    }

    [HttpPost]
    public IActionResult CreateTask(TaskDto taskDto)
    {
        var newTask = _taskService.CreateTask(taskDto);
        return CreatedAtAction(nameof(GetTaskById), new { id = newTask.Id }, newTask);
    }

    [HttpPut("{id}")]
    public IActionResult UpdateTask(int id, TaskDto taskDto)
    {
        var updatedTask = _taskService.UpdateTask(id, taskDto);
        if (updatedTask == null)
            return NotFound();
        return Ok(updatedTask);
    }

    [HttpDelete("{id}")]
    public IActionResult DeleteTask(int id)
    {
        var deleted = _taskService.DeleteTask(id);
        if (!deleted)
            return NotFound();
        return NoContent();
    }
}

Routing: Wykorzystujemy atrybuty [Route] na kontrolerze i akcjach do definiowania tras.
```
[Route("api/[controller]")]
```
Przykładowe żądania HTTP:
- Pobieranie wszystkich zadań: GET /api/tasks
- Pobieranie zadania o określonym ID: GET /api/tasks/1
- Dodawanie nowego zadania: POST /api/tasks
- Aktualizacja zadania o określonym ID: PUT /api/tasks/1
- Usuwanie zadania o określonym ID: DELETE /api/tasks/1

RPC:

Przykład będzie bardziej zorientowany na wywoływanie zdalnych operacji, bez operacji na zasobach "tasks". Kontroler TaskRpcController, który zawierać będzie zdalne metody.

[Route("api/[controller]")]
[ApiController]
public class TaskRpcController : ControllerBase
{
    private readonly ITaskService _taskService;

    public TaskRpcController(ITaskService taskService)
    {
        _taskService = taskService;
    }

		[HttpGet("getTask/{id}")]
    public IActionResult GetTask(int id)
    {
        var task = _taskService.GetTaskById(id);
        if (task == null)
            return NotFound();
        return Ok(task);
    }

    [HttpPost("createTask")]
    public IActionResult CreateTask(TaskDto taskDto)
    {
        var newTask = _taskService.CreateTask(taskDto);
        return Ok(newTask);
    }

    [HttpPost("updateTask")]
    public IActionResult UpdateTask(int id, TaskDto taskDto)
    {
        var updatedTask = _taskService.UpdateTask(id, taskDto);
        if (updatedTask == null)
            return NotFound();
        return Ok(updatedTask);
    }

    [HttpPost("deleteTask")]
    public IActionResult DeleteTask(int id)
    {
        var deleted = _taskService.DeleteTask(id);
        if (!deleted)
            return NotFound();
        return NoContent();
    }
}

W tym podejściu RPC, klient wywołuje zdalne metody na kontrolerze TaskRpcController, które odpowiadają operacjom na zadaniach. Teraz nie mamy operacji typowych dla zasobów "tasks" (takich jak GetAllTasks), ale skoncentrowaliśmy się na zdalnych operacjach do zarządzania zadaniami.

Podsumowanie

W przypadku RPC, klient wywołuje konkretne metody na kontrolerze, które są identyfikowane przez nazwy akcji. W przypadku RESTful API, klient operuje na zasobach, takich jak zadania, używając standardowych metod HTTP. Oba podejścia mają swoje miejsce w projektowaniu interfejsów API, w zależności od potrzeb projektu.

Przykłady

Podsumowanie

Materiały