Có thể nói nguyên lí REST và cấu trúc dữ liệu RESTful được biết đến rộng rãi trong giới lập trình web nói chung và lập trình ứng dụng nói riêng.
Bạn đang xem: Restful là gì
Có thể nói bản thân REST không phải là một loại công nghệ. Nó là phương thức tạo API với nguyên lý tổ chức nhất định. Những nguyên lý này nhằm hướng dẫn lập trình viên tạo môi trường xử lý API request được toàn diện.
Để hiểu rõ hơn về RESTful API ta sẽ đi lần lượt giải thích các khái niệm API, REST hay RESTful.
REST hoạt động chủ yếu dựa vào giao thức HTTP. Các hoạt động cơ bản nêu trên sẽ sử dụng những phương thức HTTP riêng.
GET (SELECT): Trả về một Resource hoặc một danh sách Resource.POST (CREATE): Tạo mới một Resource.PUT (UPDATE): Cập nhật thông tin cho Resource.DELETE (DELETE): Xoá một Resource.
Những phương thức hay hoạt động này thường được gọi là CRUD tương ứng với Create, Read, Update, Delete – Tạo, Đọc, Sửa, Xóa.
Hiện tại đa số lập trình viên viết RESTful API giờ đây đều chọn JSON là format chính thức nhưng cũng có nhiều người chọn XML làm format, nói chung dùng thế nào cũng được miễn tiện và nhanh.
Xem thêm: Assumption Là Gì – Nghĩa Của Từ Assumption
Authentication và dữ liệu trả về
RESTful API không sử dụng session và cookie, nó sử dụng một access_token với mỗi request. Dữ liệu trả về thường có cấu trúc như sau:
{ “data” : { “id”: “1”, “name”: “thienmaonline.vn ” }}
Status code
Khi chúng ta request một API nào đó thường thì sẽ có vài status code để nhận biết sau:200 OK – Trả về thành công cho những phương thức GET, PUT, PATCH hoặc DELETE.201 Created – Trả về khi một Resouce vừa được tạo thành công.204 No Content – Trả về khi Resource xoá thành công.304 Not Modified – Client có thể sử dụng dữ liệu cache.400 Bad Request – Request không hợp lệ401 Unauthorized – Request cần có auth.403 Forbidden – bị từ chối không cho phép.404 Not Found – Không tìm thấy resource từ URI405 Method Not Allowed – Phương thức không cho phép với user hiện tại.410 Gone – Resource không còn tồn tại, Version cũ đã không còn hỗ trợ.415 Unsupported Media Type – Không hỗ trợ kiểu Resource này.422 Unprocessable Entity – Dữ liệu không được xác thực429 Too Many Requests – Request bị từ chối do bị giới hạn
Nên sử dụng Version
Luôn sử dụng version để khi bạn cần nâng cấp API mà vẫn hỗ trợ các API cũ.
Xây dựng API với Laravel
Lấy việc xây dựng api trên Laravel để làm ví dụ, trước khi đi vào ta tổng quan về Http Request.
HTTP Request
HTTP request có tất cả 9 loại method , 2 loại được sử dụng phổ biến nhất là GET và POST
GET: được sử dụng để lấy thông tin từ server theo URI đã cung cấp.HEAD: giống với GET nhưng response trả về không có body, chỉ có header.POST: gửi thông tin tới sever thông qua các biểu mẫu http.PUT: ghi đè tất cả thông tin của đối tượng với những gì được gửi lên.PATCH: ghi đè các thông tin được thay đổi của đối tượng.DELETE: xóa tài nguyên trên server.CONNECT: thiết lập một kết nối tới server theo URI.OPTIONS: mô tả các tùy chọn giao tiếp cho resource.TRACE: thực hiện một bài test loop – back theo đường dẫn đến resource.
RESTful Route
Viết Api thì sẽ khai báo router vào file routes/api.php thay vì sử dụng file routes/web.php. Các setting mặc cho file api.php trong laravel:
Url: những route được khai báo trong file này mặc định có prefix url là api (ví dụ: thienmaonline.vn/api/products)Middleware: mặc định sẽ được gán Middleware Group là api, trong file app/Http/Kernel sẽ thấy 2 middleware thuộc Middleware Group: api là throttle (giới hạn request / time) và bindings (model binding).
Có thể tùy chỉnh giá trị mặc định này trong method mapApiRoutes trong file app/Providers/RouteServiceProvider.php
Tạo các route để thực hiện các thao tác như CRUD (Create, Read, Update, Delete):
// Lấy list sản phẩmRoute::get(“products”, “Api”)->name(“products.index”);// Lấy detail sản phẩm theo idRoute::get(“products/{id}”, “Api”)->name(“products.show”);// Add sản phẩmRoute::post(“products”, “Api”)->name(“products.store”);// Updatesản phẩm theo id# Sử dụng put nếu update toàn bộ các fieldRoute::put(“products/{id}”, “Api”)->name(“products.update”);# Sử dụng patch nếu update 1 vài fieldRoute::patch(“products/{id}”, “Api”)->name(“products.update”);// Xóa sản phẩm theo idRoute::delete(“products/{id}”, “Api”)->name(“products.destroy”);Mặc định route đã được gán middleware bindings, nếu muốn sử dụng model binding trong controller thì chúng ta sửa lại tham số trong route như sau:
Route::get(“products/{product}”, “Api”)->name(“products.show”);Route::put(“products/{product}”, “Api”)->name(“products.update”);Route::patch(“products/{product}”, “Api”)->name(“products.update”);Route::delete(“products/{product}”, “Api”)->name(“products.destroy”);Ngoài ra trong laravel cũng hỗ trợ chúng ta 1 cách khai báo ngắn gọn hơn:
//Nếu không muốn sử dụng toàn bộ method trong apiResource mọi người có thể chỉ định sử dụng 1 vài method bằng hàm onlyRoute::apiResource(“products”, “ApiProductController”)->only();//Hoặc nếu muốn loại bỏ đi 1 số method không dùng thì có thể sử dụng hàm exceptRoute::apiResource(“products”, “ApiProductController”)->except();
Resource Controllers
Tương ứng với các Route RESTful đã khai báo ở trên, đặc biệt nếu dùng method apiResource thì laravel cũng hỗ trợ các method xử lí tương ứng trong controller.
Xem thêm: Pic Là Gì – ý Nghĩa Của Từ Pic
Để tạo ra Resource Controllers chúng ta chạy lệnh sau
php artisan make:controller Api/ProductController -api
File ProductController tạo ra sẽ như sauNgoài ra nếu muốn sử dụng model binding khi tạo Resource Controllers thì dùng lệnh bên dưới
php artisan make:controller Api/ProductController –api –model=Models/Product
File ProductController tạo ra sẽ như sau, chúng ta để ý tham số của các method show, update, destroy sẽ thay đổi 1 chút.
Demo 1 đoạn code đơn giản trong controller kết hợp với model binding và route apiResource khi xây dựng API:
Chuyên mục: Hỏi Đáp
