3.1. Xác định các endpoint của RESTful API trong lập trình android

Trong lập trình android, xác định các endpoint của RESTful API mà ứng dụng Android của bạn sẽ giao tiếp trong Retrofit là công việc quan trọng để xây dựng các yêu cầu và phản hồi từ API. Các endpoint thường được định nghĩa trong interface API Service của bạn. Dưới đây là một ví dụ về việc xác định các endpoint trong Retrofit:

java
public interface ApiService {
    @GET("users/{id}")
    Call<User> getUser(@Path("id") int userId);

    @POST("users")
    Call<User> createUser(@Body User user);

    @PUT("users/{id}")
    Call<User> updateUser(@Path("id") int userId, @Body User user);

    @DELETE("users/{id}")
    Call<Void> deleteUser(@Path("id") int userId);
}

Trong ví dụ trên, chúng ta đã xác định các endpoint cho một tài nguyên “users”:

  • getUser: Xác định một endpoint GET để lấy thông tin một người dùng cụ thể dựa trên userId.
  • createUser: Xác định một endpoint POST để tạo mới một người dùng, với dữ liệu người dùng được truyền qua phần thân yêu cầu (@Body).
  • updateUser: Xác định một endpoint PUT để cập nhật thông tin của một người dùng cụ thể dựa trên userId, với dữ liệu người dùng được truyền qua phần thân yêu cầu.
  • deleteUser: Xác định một endpoint DELETE để xóa một người dùng cụ thể dựa trên userId.

Các endpoint này phải tương ứng với các địa chỉ URL của API của bạn, ví dụ: "https://api.example.com/users/{id}".

Lưu ý rằng bạn cần xác định các yêu cầu tương ứng với mỗi endpoint, sử dụng các annotation như @GET, @POST, @PUT, @DELETE và các annotation khác như @Path, @Query, @Body, @Header để cung cấp thông tin cần thiết cho các yêu cầu API.

Tùy thuộc vào RESTful API mà bạn đang làm việc, số lượng và loại các endpoint có thể khác nhau. Việc xác định các endpoint phụ thuộc vào cấu trúc và yêu cầu cụ thể của API mà bạn đang giao tiếp.

Leave a Comment

Your email address will not be published. Required fields are marked *

Scroll to Top