RESTful API là gì? Cách thiết kế RESTful API | TopDev

Bạn đang quan tâm đến RESTful API là gì? Cách thiết kế RESTful API | TopDev phải không? Nào hãy cùng Vuihecungchocopie đón xem bài viết này ngay sau đây nhé, vì nó vô cùng thú vị và hay đấy!

Chúng ta có thể nói rằng các nguyên tắc rest và cấu trúc dữ liệu restful rất nổi tiếng trong lập trình web, đặc biệt là lập trình ứng dụng.

Có thể nói rằng bản thân phần còn lại không phải là một công nghệ. Đó là một cách để tạo các API với các nguyên tắc tổ chức nhất định. Các nguyên tắc này nhằm hướng dẫn các nhà phát triển tạo một môi trường xử lý yêu cầu API toàn diện.

Bạn đang xem: Restful api là gì

Để hiểu rõ hơn về api yên tĩnh , chúng tôi sẽ giải thích khái niệm api , nghỉ ngơi hoặc yên tĩnh tương ứng.

Api yên tĩnh là gì?

api còn lại là một tiêu chuẩn để thiết kế api cho các ứng dụng web (thiết kế dịch vụ web) để tạo điều kiện quản lý tài nguyên. Nó tập trung vào tài nguyên hệ thống (tệp văn bản, hình ảnh, âm thanh, video hoặc dữ liệu động …), bao gồm trạng thái tài nguyên được định dạng và truyền qua http.

Xem thêm: Cơ hội tuyển dụng lập trình viên API hàng đầu của Topdev

Giải thích phần tử

api ( a ứng dụng p lập trình i giao diện) là một tập hợp các quy tắc và cơ chế thông qua đó Quy tắc và các cơ chế mà ứng dụng hoặc thành phần tương tác với ứng dụng hoặc thành phần khác. Api có thể trả về dữ liệu mà ứng dụng của bạn cần ở các kiểu dữ liệu phổ biến như json hoặc xml.

rest ( re presentational s tate t transfer) là một phép chuyển đổi cấu trúc dữ liệu, một lược đồ kiểu viết api. Nó sử dụng các phương thức http đơn giản để tạo điều kiện giao tiếp giữa máy và máy. Do đó, thay vì sử dụng url để xử lý một số thông tin người dùng, phần còn lại sẽ gửi yêu cầu http tới url, chẳng hạn như get, post, delete, v.v., để xử lý dữ liệu.

api an toàn là một tiêu chuẩn cho các API được thiết kế để quản lý tài nguyên trong các ứng dụng web. restful là một trong những thiết kế api được sử dụng nhiều nhất hiện nay để cho phép các ứng dụng khác nhau (web, di động …) giao tiếp với nhau.

phần còn lại Chức năng quan trọng nhất là chỉ định cách sử dụng các phương thức http (chẳng hạn như lấy, đăng, đặt, xóa …) và cách định dạng url cho các ứng dụng web để quản lý tài nguyên. Restful không chỉ định logic mã ứng dụng và không bị giới hạn bởi ngôn ngữ lập trình ứng dụng. Bất kỳ ngôn ngữ hoặc khuôn khổ nào cũng có thể được sử dụng để thiết kế restful api .

nghỉ ngơi hoạt động như thế nào?

phần còn lại chủ yếu hoạt động trên giao thức http. Các thao tác cơ bản trên sẽ sử dụng các phương thức http riêng.

• get (select): Trả về một tài nguyên hoặc danh sách các tài nguyên.
• đăng (tạo): Tạo tài nguyên mới.
• put (cập nhật): Cập nhật thông tin tài nguyên.
• xóa: xóa tài nguyên.

Các phương pháp hoặc thao tác này thường được gọi là crud và tương ứng với tạo, đọc, cập nhật, xóa – tạo, đọc, chỉnh sửa, xóa.

Hiện tại, hầu hết các lập trình viên viết restful api đều chọn json làm định dạng chính thức, nhưng nhiều người chọn xml làm định dạng. Nói chung, việc sử dụng bất cứ thứ gì họ muốn là thuận tiện và nhanh chóng. .

Xác thực và trả về dữ liệu

api an toàn không sử dụng phiên và cookie, nó sử dụng access_token cho mỗi yêu cầu. Dữ liệu trả về thường có cấu trúc như sau:

Mã trạng thái

Xem thêm: Loại màn hình TFT, LCD. là gì?

Khi chúng tôi yêu cầu một api, thường có một số mã trạng thái cần được xác định:

• 200 ok – Phương thức get, put, patch hoặc delete trả về thành công.
• 201 được tạo – Được trả lại khi tài nguyên được tạo thành công.
• 204 Không có Nội dung – Được trả lại nếu tài nguyên đã được xóa thành công.
• 304 Không được Sửa đổi – Khách hàng có thể sử dụng dữ liệu đã lưu trong bộ nhớ cache.
• 400 Yêu cầu Không hợp lệ – Yêu cầu Không hợp lệ
• 401 Không được phép – Yêu cầu yêu cầu xác thực.
• 403 Cấm – Bị từ chối.
• 404 Không tìm thấy – Không tìm thấy tài nguyên từ uri
• Phương thức 405 Không được phép – Người dùng hiện tại không cho phép phương thức này.
• Đã hết 410 – tài nguyên không còn tồn tại, Các phiên bản cũ hơn không còn được hỗ trợ.
• 415 Loại phương tiện không được hỗ trợ – Loại tài nguyên này không được hỗ trợ.
• 422 Đối tượng không thể xử lý – Dữ liệu không được xác thực
• 429 Yêu cầu quá nhiều – Yêu cầu bị từ chối do thời hạn giới hạn

Phiên bản nên được sử dụng

Luôn sử dụng phiên bản để khi bạn cần nâng cấp api của mình mà vẫn hỗ trợ api cũ.

Xây dựng api với laravel

Lấy api được xây dựng trên laravel làm ví dụ, sau đó nhập tổng quan về các yêu cầu http.

Yêu cầu http

Có 9 phương pháp cho các yêu cầu http, hai phương pháp thường được sử dụng nhất là get và post

• get: Được sử dụng để lấy thông tin từ máy chủ dựa trên uri đã cung cấp.
• head: Tương tự như get, nhưng phản hồi không trả về nội dung, chỉ trả về tiêu đề.
• bài đăng: Gửi thông tin đến máy chủ qua biểu mẫu http.
• put: Ghi đè tất cả thông tin của đối tượng với nội dung đã gửi.
• bản vá: Ghi đè thông tin thay đổi của đối tượng.

li>

• xóa: Xóa tài nguyên trên máy chủ.
• kết nối: thiết lập kết nối với máy chủ thông qua uri.
• tùy chọn: Mô tả các tùy chọn giao tiếp cho tài nguyên.

li>

• dấu vết: Thực hiện các bài kiểm tra lặp lại dọc theo các đường dẫn tài nguyên.

Tuyến đường yên tĩnh

Viết api sẽ khai báo bộ định tuyến trong tệp tuyến đường / api.php thay vì sử dụng tệp tuyến đường / web.php. Cài đặt mặc định cho tệp api.php trong laravel:

• url: Tiền tố mặc định của các tuyến được khai báo trong tệp này là url api (ví dụ: topdev.vn/api/products)
• middleware: Middleware mặc định sẽ được gán nhóm là api, Trong ứng dụng tệp / http / kernel, bạn sẽ thấy 2 phần mềm trung gian thuộc nhóm phần mềm trung gian: api là điều tiết (yêu cầu giới hạn / thời gian) và ràng buộc (ràng buộc mô hình).

Giá trị mặc định này có thể được tùy chỉnh trong phương thức mapapiroutes của tệp ứng dụng / nhà cung cấp / routeerviceprovider.php

Tạo các tuyến đường để thực hiện các thao tác như crud (tạo, đọc, cập nhật, xóa):

Tuyến đã được gán ràng buộc phần mềm trung gian theo mặc định. Nếu bạn muốn sử dụng liên kết mô hình trong bộ điều khiển, chúng tôi sửa đổi các thông số trong tuyến như sau:

Phương thức khai báo đơn giản hơn của chúng tôi cũng được hỗ trợ trong laravel:

Bộ điều khiển tài nguyên

Tương ứng với lộ trình thư giãn được khai báo ở trên, đặc biệt nếu phương thức apiresource được sử dụng, laravel cũng hỗ trợ phương thức xử lý tương ứng trong bộ điều khiển.

Để tạo bộ điều khiển tài nguyên, chúng tôi chạy lệnh sau

thợ làm php: controller api / productcontroller-api

Ngoài ra, nếu bạn muốn sử dụng liên kết mô hình khi tạo bộ điều khiển tài nguyên, hãy sử dụng lệnh sau

thợ làm thủ công php: controller api / productcontroller -api -model = models / product

Tệp được tạo bởi productcontroller như sau, chúng tôi nhận thấy rằng các thông số của phương thức hiển thị, cập nhật, hủy sẽ thay đổi một chút.

demo 1 Mã đơn giản trong bộ điều khiển kết hợp nguồn liên kết mô hình và nguồn định tuyến khi tạo api:

Xem thêm: Tê hai bàn tay phải làm sao? – Bệnh viện Đa khoa Vạn Hạnh

Khi định tuyến apiresource được sử dụng theo mặc định, dữ liệu trả về sẽ tự động được chuyển đổi thành kiểu json và có trạng thái tương ứng, vì vậy bạn có thể trả về trực tiếp.

Ngoài ra, nếu bạn muốn tùy chỉnh trạng thái trả về, bạn có thể tham khảo phương pháp sau và sử dụng lớp chiếu sáng http response để nhận trạng thái thay vì một giá trị cố định, chẳng hạn như http_ok ​​sẽ là 200

Khi xây dựng api, bạn có thể cần phải chuyển đổi dữ liệu từ bộ điều khiển trước khi trả lại cho người dùng ứng dụng của mình, laravel đã hỗ trợ điều này thông qua tài nguyên hùng hồn

Để tạo một lớp chuyển đổi, chúng tôi chạy lệnh sau

nghệ nhân php làm: sản phẩm tài nguyên

Tệp app / http / resources / product.php sẽ có nội dung sau

Tôi sẽ tùy chỉnh dữ liệu trả về để chỉ có tiêu đề và giá cả

Trong bộ điều khiển, tôi đã thay đổi nó như sau

Ngoài việc trả về các dữ liệu như tiêu đề hay giá cả, laravel hỗ trợ thêm các mối quan hệ, dữ liệu … và nhiều thứ nữa, mọi người có thể đọc thêm tài liệu trên laravel.

Ủy quyền

Hiện tại có ba cơ chế ủy quyền chính:

• http basic
• mã thông báo web json (jwt)
• oauth2

Dựa trên dịch vụ của bạn, hãy chọn loại ủy quyền thích hợp và giữ nó càng đơn giản càng tốt.

chính sách cors

Viết api, cũng cần chú ý đến cors là gì?

tài liệu api

Mọi người đều biết rằng việc viết tài liệu api là cần thiết, nhưng một tài liệu api hoàn chỉnh cũng tốn nhiều thời gian. Đặc biệt là khi dự án đang gấp rút, mọi người có xu hướng chỉ để lại tài liệu api ở mức siêu cơ bản. Xem thêm cách viết tài liệu api.

tài liệu api là một phần tương tự như các bài kiểm tra đơn vị – ngắn và dài.

Nếu không được xử lý cẩn thận, đến lúc phải bảo trì hoặc thay đổi thông số kỹ thuật, hậu quả có thể rất nghiêm trọng. Dưới đây là một số điều cần lưu ý khi viết tài liệu:

• Mô tả đầy đủ các tham số yêu cầu: tham số nào được bao gồm, kiểu dữ liệu, bắt buộc hoặc tùy chọn.
• Nên đưa ra các ví dụ về các yêu cầu và phản hồi http cho dữ liệu chuẩn.
• Cập nhật tài liệu thường xuyên để nắm bắt được những thay đổi đối với API càng tốt càng tốt.
• Định dạng và cú pháp phải nhất quán và mô tả phải rõ ràng và chính xác.

Xem thêm các công việc api lương cao hấp dẫn tại đây

Xem thêm: Part Number Là Gì – Nghĩa Của Từ Part Number – WEB GIẢI ĐÁP