Kết nối với API mà không cần mã: 8 bước

2025 Tác giả: John Day | [email protected]. Sửa đổi lần cuối: 2025-01-23 15:14

Hướng dẫn này được thiết kế cho những người có điều gì đó họ muốn hoàn thành yêu cầu sử dụng API, nhưng không chắc chắn về cách bắt đầu. Bạn đã biết tại sao có thể làm việc với API lại hữu ích và hướng dẫn này sẽ chỉ cho bạn cách làm điều đó.

Nếu điều đó nghe giống như bạn, bạn đang may mắn! Chúng tôi ở đây để giải thích cách làm việc với API, cách đọc tài liệu API và cách thực sự sử dụng dữ liệu lấy lại từ API.

Chúng tôi đã mang theo một người bạn để làm cho cuộc hành trình dễ dàng hơn nhiều.

Gặp Slash

Slash là chú chó xinh xắn, đáng yêu của Michelle (ảnh trên). Michelle là một kỹ sư phần mềm, người xây dựng các API. Michelle thực sự yêu thích công việc của mình và đã lấy cảm hứng từ các API xây dựng công việc của mình trong việc đào tạo Slash.

Như bạn có thể biết, API là một tập hợp các lệnh mà người dùng có thể đưa ra cho một dịch vụ web cùng với một tập hợp các phản hồi phù hợp với yêu cầu. Michelle đã huấn luyện Slash làm điều tương tự. Slash là một cậu bé ngoan, biết nhiều lệnh và luôn trả lời chính xác miễn là bạn đưa ra yêu cầu mà cậu ấy đã được dạy. Khi anh ta quá phấn khích, đuôi của anh ta phát điên lên - đây không phải là điều mà Michelle đã dạy anh ta liên quan đến API, mà chỉ vì anh ta là một chú chó đáng yêu và thực sự thích đào tạo của mình!

Bước 1: Quyết định API bạn cần

Thông tin nào bạn đang tìm kiếm hoặc bạn muốn thay đổi?

Bạn đang cố gắng lấy tất cả các bài đăng trên Instagram của @ dougthepug? Có thể bạn muốn tự động tweet với bất kỳ ai theo dõi twitter của con chó của bạn (bởi vì mặc dù chó không thể nói nhưng chúng có rất nhiều điều để nói, chúng tôi biết chắc chắn Slash có).

Nếu bạn đã biết trang web hoặc API mà bạn đang cố gắng kết nối, hãy chuyển trực tiếp sang Bước 2. Nếu bạn đang cố gắng tìm kiếm dữ liệu nhưng không chắc nên bắt đầu từ đâu, Google là bạn của bạn. Tìm kiếm API "[những thứ bạn quan tâm]" và xem những gì xuất hiện. Bạn có thể ngạc nhiên về số lượng thông tin ngoài kia.

Nếu bạn muốn một API mẫu đơn giản, bạn có thể sử dụng API mà Michelle đã tạo trong khi đào tạo Slash. Nó có một số lệnh yêu thích của anh ấy như lấy quả bóng và đào lỗ. Chúng tôi sẽ sử dụng nó trong suốt phần còn lại của các ví dụ của chúng tôi.

Bước 2: Tìm tài liệu API

Các API được cung cấp bởi các công ty nổi tiếng phải có tài liệu kỹ lưỡng về cách sử dụng chúng.

Để tìm những thứ này, hãy google "tài liệu API [Insert Company]" hoặc "[Insert Company] developer".

Kết quả sẽ đưa bạn đến cổng nhà phát triển. Tìm liên kết có nội dung "Tài liệu", "Tài liệu", "Tài liệu tham khảo" hoặc "Tài liệu tham khảo kỹ thuật".

Trong tài liệu, bạn có thể cần tìm API cụ thể mà bạn muốn vì đôi khi có thể có nhiều tùy chọn. Ví dụ, Facebook có các API riêng biệt cho tiếp thị, quảng cáo, trang, v.v.

Nếu API bạn muốn kết nối không nổi tiếng (như của Slash), bạn có thể cần yêu cầu nhà phát triển cung cấp tài liệu. Họ có thể có một tệp PDF chứa thông tin bạn cần hoặc tài liệu trực tuyến không được liệt kê trên trang web của họ.

Nếu bạn bỏ lỡ liên kết ở bước trước, bạn có thể tìm thấy tài liệu API của Slash tại đây.

Bước 3: Tìm điểm cuối

Tài liệu API có thể trông khó khăn, nhưng một khi bạn biết những gì cần tìm, chúng thường có cấu trúc tốt và được tiêu chuẩn hóa khá tốt.

Điều đầu tiên cần tìm là (các) điểm cuối thích hợp. Cần có một điểm cuối tương ứng với từng loại dữ liệu bạn muốn. Một điểm cuối có thể trông như thế này:

slashtheapidog.com/api/bone/{id}

hoặc chỉ

/ xương

Tài liệu nên có một danh sách các điểm cuối. Chúng có thể là cấp cao nhất trong tài liệu hoặc trong một phần được gọi là "tham chiếu", "điểm cuối" hoặc "phương pháp". Để tìm đúng điểm cuối, hãy tìm tên tương ứng với dữ liệu bạn đang tìm kiếm. Ví dụ, nếu bạn muốn có một danh sách tất cả các lỗ mà Slash đã đào, / lỗ có thể là một trong những lỗ phù hợp. Trong mọi trường hợp, mỗi điểm cuối phải có một mô tả để giúp giải thích chức năng của nó.

Từ tài liệu của anh ấy, đây là các điểm cuối trong API của Slash liên quan đến các lỗ hổng:

TẢI

TẢI

ĐĂNG

ĐẶT

ĐĂNG

Bước 4: Xác định loại yêu cầu của bạn

Bây giờ bạn đã tìm thấy điểm cuối phù hợp, bạn cần xác định loại yêu cầu để gửi nó.

Có 4 loại yêu cầu khác nhau:

HIỂU ĐƯỢC

Yêu cầu GET là cách bạn yêu cầu API phản hồi với thứ mà nó có, thường là dữ liệu. Bạn có thể yêu cầu thông tin cụ thể về một mặt hàng hoặc một nhóm mặt hàng dựa trên điểm cuối và các thông số. Điều này tương đương với việc yêu cầu Slash mang cho bạn một trong những bộ xương của anh ta hoặc tất cả xương của anh ta.

BÀI ĐĂNG

Yêu cầu ĐĂNG là cách bạn yêu cầu API tạo một cái gì đó mới. Điều này tương tự như yêu cầu Slash đào (tạo) một cái hố mới cho bạn.

ĐẶT

Yêu cầu PUT là cách bạn yêu cầu API cập nhật thứ gì đó đã được tạo trước đó. Điều này tương tự như yêu cầu Slash đào sâu hơn (cập nhật) vào cái hố mà anh ta đã đào.

XÓA BỎ

Yêu cầu XÓA là cách bạn yêu cầu API xóa nội dung nào đó đã được tạo trước đó. Điều này tương tự như việc yêu cầu Slash che đậy (xóa) một cái hố mà anh ta đã đào trước đó.

Hãy suy nghĩ về bốn loại này. Bạn đang nhận thông tin, tạo mục nhập mới, thay đổi mục nhập hiện có hoặc xóa mục nhập đó? Câu trả lời đó cho bạn biết chính xác loại yêu cầu bạn cần.

Bước 5: Hiểu các thông số

Nhiều yêu cầu yêu cầu các tham số bổ sung. Các thông số là các chi tiết của yêu cầu của bạn. Ví dụ, nếu bạn muốn Slash mang đến cho bạn tất cả các quả bóng có màu đỏ, bạn cần chỉ định màu. Nếu bạn muốn anh ta tạo một cái hố mới, bạn cần nói cho anh ta biết vị trí đặt nó và độ sâu để đào.

Tài liệu API mà bạn đang tham chiếu phải có một phần được gọi là "Tham số" hoặc "Tùy chọn" cho mỗi điểm cuối và loại yêu cầu. Chú ý đến thông số nào là bắt buộc vì một số là tùy chọn. Nếu một tham số được đánh dấu là tùy chọn, tài liệu có thể cung cấp một ví dụ cũng là thông số mặc định.

Các thông số API của Slash có thể trông giống như thế này để truy xuất các quả bóng:

TẢI

Bước 6: Định dạng yêu cầu của bạn

Chúng tôi đã có tất cả thông tin cần thiết, bây giờ chúng tôi chỉ cần đưa ra yêu cầu!

Đây là hai cách khác nhau để kết nối với một API không yêu cầu mã. Hãy kết nối với API của Slash để nhận danh sách các quả bóng của anh ấy bằng cách thực hiện yêu cầu GET tới

Hình parabol - nếu bạn muốn kết nối và làm việc với dữ liệu mà không cần mã

Parabola là một ứng dụng web cho phép bạn dễ dàng kết nối với các API và sau đó làm việc với dữ liệu thông qua một công cụ trực quan, kéo và thả.