Endpoint là gì? Lợi ích trong việc phát triển APIs | TopDev

Bài viết được sự cho phép của tác giả le chi dung

Điểm cuối là gì?

Để dễ hiểu, tôi sẽ đưa ra một ví dụ về điểm cuối.

Khi ứng dụng gọi url api: https://abc.com/foo/bar Bây giờ chúng tôi gọi / foo / bar làm điểm cuối.

endpoint là một phần quan trọng của sự phát triển api

Xác định chức năng (tạo kế hoạch hành động)

Công việc đầu tiên của bạn là suy nghĩ về những gì api của bạn sẽ cung cấp. Nó có thể là một danh sách các chức năng thô sơ (tạo, đọc, cập nhật, xóa) để sử dụng với tài nguyên của bạn. Để được giải thích rõ hơn, đây là danh sách các “hành động” được thực hiện trên mỗi tài nguyên: Ví dụ:

Bạn có tài nguyên người dùng và bạn cần danh sách các chức năng như sau: người dùng:

• Tạo
• Đọc
• Cập nhật
• Xóa
• Danh sách

Công việc tương tự như tdd, tức là bạn tìm ra hàm để viết và viết mã, giả sử hàm và lớp đã tồn tại, sau đó bạn xác định chúng.

p>

Nếu api của bạn có khả năng tìm kiếm theo tên người dùng hoặc mã, công việc sẽ được liệt kê: người dùng:

• Tạo
• Đọc
• Cập nhật
• Xóa
• danh sách (tên, id)

Thêm thông số có thể đẹp và dễ hình dung, nhưng đừng thêm quá nhiều và việc thêm tất cả các thuộc tính để tạo (tên, id, tuổi, …), v.v. là thừa.

Lý thuyết về sự yên tĩnh

Việc chuyển đổi một kế hoạch hành động thành một danh sách các điểm cuối yêu cầu hiểu biết cơ bản về các API hữu ích và có tên là “các phương pháp hay nhất”. Tất nhiên, mỗi công ty, mỗi tập đoàn đều có những tiêu chuẩn đặt tên khác nhau và không thể so sánh được cái nào tốt nhất. Tuy nhiên, tôi sẽ nói về những cái phổ biến mà tôi nghĩ là tốt nhất cho bạn. phần còn lại bao gồm nhiều, nhưng có bốn cái cơ bản: get – post-put -delete

1. nhận được

• get / resources – Tìm danh sách các bản ghi từ các tài nguyên được phân trang hoặc lấy tất cả các bản ghi
• get / resources / x – chỉ lấy bản ghi x, ví dụ / users / thanhtriphap -> lấy thông tin của tôi
• get / resources / x, y, z – người dùng muốn tìm kiếm nhiều tiêu chí hoặc một tiêu chí duy nhất có nhiều giá trị
• get / place / x / users – Thu hút tất cả người dùng sống trong x khu vực
• get / users / x / place – Đến tất cả những nơi mà người dùng đã đến hoặc đã đến
• lấy / người dùng / x / địa điểm / y – tìm kiếm người dùng theo x, địa điểm theo y

Tăng tự động [Vùng nguy hiểm]

Bạn thường sử dụng id tự động tăng dần trong quá trình học ở trường. Nhưng thực ra nếu api của chúng ta như thế này, chúng ta có thể biết chúng ta có bao nhiêu tài nguyên, rất hữu ích cho đối thủ đó. Giải pháp là sử dụng uuid – bạn có thể google uuid cho php, ruby ​​hoặc python và các gói hỗ trợ gen uuid.

2. xóa

• xóa / người dùng / x – xóa người dùng
• xóa / người dùng / x, y, z – xóa một vài dòng dữ liệu
• xóa / người dùng – xóa tất cả các hàng dữ liệu ( không nên )
• xóa / người dùng / x / hình ảnh – xóa hình ảnh của người dùng x
• xóa / người dùng / x / hình ảnh – xóa một loạt hình ảnh cho người dùng x

3. Xuất bản và đặt

Về mặt lý thuyết, post được sử dụng để tạo các dòng dữ liệu mới, trong khi put được sử dụng để cập nhật các dòng dữ liệu hiện có. Đó là sự khác biệt, nhưng về nguyên tắc, hai hành động giống nhau, đó là những gì một bài đăng có thể làm, những gì một đặt có thể làm và ngược lại. Nhưng tất nhiên phải có sự khác biệt cơ bản để sử dụng. Chúng ta thấy khái niệm iđêan: có nghĩa là khi chúng ta gọi tài nguyên với n lần đặt, hành vi vẫn giống nhau và dữ liệu được thay đổi ở lần thứ n vẫn giống như lần gọi đầu tiên sức mạnh, v.v.: / p>

Nghe có vẻ khó hiểu, hãy lấy một ví dụ:

• Giả sử chúng tôi chỉ có 1 hình đại diện cho mỗi sản phẩm (chỉ 1), mỗi khi chúng tôi thay đổi hình đại diện, tức là thay đổi hình đại diện của sản phẩm, dữ liệu vẫn giữ nguyên (cũ ở đây có nghĩa là không có hàng mới nào được tạo): put / products / ao-so-mi-tay-dai-mb2331 / image
• Cùng một ví dụ, nhưng sản phẩm có nhiều hình ảnh, mỗi khi chúng tôi thêm một hàng dữ liệu mới, chúng tôi sử dụng bài đăng vì dữ liệu thay đổi: bài đăng / sản phẩm / quan-tay / hình ảnh
  

  4. danh từ số nhiều, số ít hoặc cả hai

  Một số nhà phát triển sử dụng danh từ số ít, một số sử dụng số nhiều. Ví dụ:

  • get / user / 1 – trả về người dùng có id 1
  • get / user – muốn biết người dùng nào sẽ được trả lại hoặc tất cả họ

  Vì vậy, tôi thường sử dụng số nhiều làm điểm cuối:

  • get / users / 1 – trả về người dùng có id 1
  • get / users? limit = 5 – trả về 5 người dùng mỗi lượt

  5. danh từ hoặc động từ

  Trước đây, một số nhà phát triển đã sử dụng động từ khi đăng bài:

  • Đăng / Gửi tin nhắn
  • Đăng / người dùng / 5 / gửi tin nhắn

  Tuy nhiên, điều này có vẻ là một chút vấn đề, chúng ta chỉ cần 1 động từ, tức là post put hoặc get … và url là một danh từ không phải là một động từ. Dưới đây là một số ví dụ:

  • post / users / 5 / message – gửi tin nhắn cho người dùng 5

  Một cách tốt hơn chúng tôi:

  • Đăng / người dùng / thanhtriphap / tin nhắn
  • Nhập / users / thanhtriphap / message / wsis0n

  Xây dựng điểm cuối

  Sau khi định cấu hình get, put, post …>

  • Bộ điều khiển Người dùng
  • Bộ điều khiển danh mục
  • Bộ điều khiển vị trí

  và hoàn tất quá trình định tuyến. Ví dụ trên laravel framework

  Kết luận

  Làm bất cứ điều gì sẽ giúp chúng ta dễ dàng hơn trong tương lai nếu chúng ta xác định rõ ràng công việc phải hoàn thành. Tạo điểm cuối là một cách để phần phụ trợ làm việc với các nhà phát triển di động hoặc giao diện người dùng cùng nhau và hiệu quả hơn.

  Bài viết gốc trên lcdung.top

  Bạn có thể quan tâm:

  • 9 công cụ siêu tiện dụng dành cho nhà phát triển và nhà thiết kế
  • Các công cụ được sử dụng trong phát triển vue.js
  • 5 bài học kinh nghiệm từ việc phát triển ứng dụng web

  Xem thêm các công việc thú vị dành cho nhà phát triển trên topdev