Thông thường, các doanh nghiệp sẽ vứt bỏ đi các giao diện lập trình trên nền tảng web công khai với hy vọng các lập trình viên sẽ cải thiện và nâng cấp chúng. Nhưng sau đó không có việc gì xảy ra. Đó là bởi vì có một số yếu tố quan trọng có thể đang thiếu sót. Một biên tập viên và tư vấn doanh nghiệp – Bruno Pedro gần đây xem xét các tính năng mà các lập trình viên muốn và cần đến trong các giao diện lập trình ứng dụng mà họ muốn áp dụng.

Trong một nền kinh tế phụ thuộc vào các khả năng của công ty đối với dự án cung cấp đến thị trường thông qua các giao diện lập trình ứng dụng, các lập trình viên có vai trò là “một cử tri”, quan trọng như các khách hàng của họ. Như Pedro đánh giá việc này khá khôn ngoan rằng giao diện lập trình ứng dụng ảnh hưởng đến công ty và sản phẩm của họ; các lập trình viên đóng vai trò quan trọng nhất đối với giao diện lập trình ứng dụng.

Đối với phần mềm dày dạn, các nguyên tắc cơ bản của bản thiết kế và việc cung cấp các giao diện lập trình ứng dụng tuyệt vời trên nền tảng web cũng tương tự đối với bất kỳ gói phần mềm nào phát hành kể từ đó, mang tính giản dị, các tài liệu và hầu hết tất cả sự hỗ trợ cần thiết. Các nguyên tắc cơ bản này cần được tinh chỉnh một chút trong thời kì giao diện lập trình ứng dụng, nhưng họ vẫn cố gắng để thực hiện và đó là sự thật.

Pedro lập ra danh sách gồm có 5 yếu tố đặc trưng quan trọng nhất của mỗi giao diện lập trình ứng dụng nên có. Theo phương pháp này, những yếu tố này áp dụng cho các giao diện lập trình ứng dụng nội bộ được chia sẻ   giữa các đơn vị doanh nghiệp cũng như các các giao diện lập trình ứng dụng ra mắt trước với cộng đồng.

1. Đơn giản để đăng ký: 

Điều quan trọng đối với các lập trình viên là hướng đến “khách hàng”, Pedro tuyên bố. Họ nên “hiểu một cách nhanh chóng tính năng chính của giao diện lập trình ứng dụng đang cung cấp và làm thế nào để họ có thể bắt đầu sử dụng nó”. Pedro cho biết quy tắc 3:30:3 của Ori Pekelman để giúp đỡ các lập trình viên lựa chọn ứng dụng của bạn: “Trên trang chủ của giao diện lập trình ứng dụng của bạn, một lập trình viên nên: Hiểu nhanh về mục đích của giao diện lập trình ứng dụng của bạn, có thể xác định điểm  nhập vào trong 30s, và có thể tạo ra một tài khoản, gọi hệ thống và nhận được kết quả mong muốn dưới 3 phút”.

2. Cung cấp một ‘sandbox’ để chơi: 

“Một cách tuyệt vời để cho phép các lập trình viên kiểm tra giao diện lập trình ứng dụng của bạn mà không tạo ra một tài khoản thực là để cung cấp một ‘sandbox’ bắt chước toàn bộ các tính năng mà không cần thực hiện bất kỳ thông tin thực nào”, Pedro cho biết. “Sự khác nhau quan trọng thường là điểm cuối ‘sandbox’ sẽ có đường dẫn URL của chính nó”. Các nền tảng như là Vargrant và Docker giúp phát hành môi trường kiểm thử.

3. Cung cấp tài liệu: 

Tài liệu là ” điều đầu tiên mà các lập trình viên tìm kiếm khi muốn bắt đầu sử dụng giao diện lập trình ứng dụng”, Pedro nói rõ . Một phần nội dung của tài liệu, ông ấy đề nghị có các mẫu code, các phương thức giao diện lập trình ứng dụng hiện có, các tham số và phản ứng ; các định dạng đầu vào và đầu ra chẳng hạn như JSON hay XML. Đồng thời cũng bao gồm các chi tiết ” chính xác là làm thế nào sự cấp phép hoạt động và những tùy chọn gì hữu ích đối với các lập trình viên” cũng như các phát thảo về các khái niệm và các điều kiện.

4. Cung cấp các nguồn xử lý sự cố: 

“Trong trường hợp gặp phải một số sai sót, nên có những công cụ để khắc phục sự cố  và có thể là một giao diện lập trình ứng dụng cập nhật trạng thái”, Pedro khuyên. “Thường hơn những gì mong đợi, một giao diện lập trình ứng dụng hoạt động theo cách mà các lập trình viên không mong muốn thì giao diện này nên dễ hiểu đối với những gì thật sự xảy ra”. Cùng với giao diện điều khiển, cung cấp một diễn đàn trực tuyến cho việc thảo luận các vấn đề tương tác.

5. Giao tiếp

Cố gắng tiếp tục giữ các lập trình viên dù có bất kỳ sự thay đổi nào hay nâng cấp cho giao diện lập trình ứng dụng, và luôn luôn giữ liên lạc với các lập trình viên quan trọng. Pedro cũng khuyên sử dụng danh sách các email, các trang blog và phương tiện truyền thông để tương tác với các lập trình viên?

Nguồn bài viết : zdnet.com