Mục lục:
- Làm bài tập về nhà đi
- Kiên định
- Sử dụng OAuth
- Bắt đầu sớm
- Viết tài liệu tốt
- Phát triển API: Giữ cho nó đơn giản
Đó là bản chất của phát triển phần mềm. Các nhà phát triển tạo ra phần mềm với tâm trí người dùng cuối. Có vẻ khá đơn giản, nhưng đôi khi những người dùng đó cũng là những nhà phát triển đồng nghiệp. Họ không cần những thứ đổ vỡ cho họ. Họ thậm chí không cần sự đơn giản. Tất cả những gì họ muốn là truy cập - một cách để tích hợp phần mềm của bạn với họ. Đây là nơi xuất hiện API (giao diện lập trình ứng dụng). Tôi hy vọng sẽ làm nổi bật năm bước mà bạn có thể thực hiện để tạo API thành công.
Làm bài tập về nhà đi
Khi nói đến phát triển phần mềm, không ai trong chúng ta muốn phát minh lại bánh xe. Tại thời điểm này, hầu hết tất cả các công ty web lớn đều có API cho các sản phẩm phần mềm của họ. Nghiên cứu các API này và cố gắng chọn ra các quyết định thiết kế khác nhau đã tạo ra chúng.
Có nhiều công nghệ khác nhau, nhưng hầu hết các API bạn sẽ thấy sẽ sử dụng giao diện RESTful hoặc SOAP. Nếu bạn đang ở trên hàng rào về giao diện API nào bạn sẽ sử dụng, tôi khuyên bạn nên sử dụng phương pháp RESTful bằng giao thức HTTP. Nó đơn giản hơn SOAP, hiện đang phổ biến hơn và sẽ dễ dàng bắt đầu hơn khi sử dụng sản phẩm phần mềm dựa trên Web.
Kiên định
Một trong những điều mà các nhà phát triển đánh giá cao nhất là tính nhất quán. Điều này bao gồm, trong số những thứ khác, địa chỉ, đối số đầu vào, định dạng đầu ra và xử lý lỗi.
Khi sử dụng cách tiếp cận RESTful, có nhiều cách đặt tên URI khác nhau. Mỗi người đều có những người ủng hộ, vì vậy chỉ cần chọn một và gắn bó với nó. Điều tương tự cũng xảy ra với cấu trúc đầu vào và đầu ra. Hầu hết các API hỗ trợ sử dụng XML và JSON làm định dạng đầu vào và đầu ra. Tôi sẽ đề nghị hỗ trợ cả hai, nhưng chọn một định dạng mặc định.
Đối với đầu vào, các yêu cầu đầu vào của bạn phải được đặt tên nhất quán và có ý nghĩa trong ngữ cảnh của lệnh gọi API bạn đang thực hiện. Đối với đầu ra, đảm bảo rằng bạn đang sử dụng bố cục cấu trúc dữ liệu phổ biến. Nếu bạn đang gói đầu ra của một lệnh gọi API trong một
Đó là một thực tế phổ biến để bao gồm một số loại cờ trạng thái trong dữ liệu đầu ra bạn gửi lại cho khách hàng. Khi sử dụng cách tiếp cận API RESTful, điều này nên được thực hiện bằng cách sử dụng mã trạng thái HTTP. Chẳng hạn, nếu bạn vừa xử lý yêu cầu PUT trên một đối tượng dữ liệu hiện có, mã trạng thái HTTP mà bạn đưa vào trong phản hồi của mình sẽ thay đổi tùy thuộc vào kết quả của yêu cầu.
Thay vì cờ tùy ý cho biết trạng thái của cuộc gọi, mã trạng thái "200 OK" tiêu chuẩn có thể được sử dụng để biểu thị rằng yêu cầu đã thành công, trong khi mã trạng thái "400 Yêu cầu xấu" có thể được sử dụng để biểu thị rằng yêu cầu là dị hình. Có khá nhiều mã trạng thái HTTP có thể được sử dụng trong các tình huống khác nhau.
Sử dụng OAuth
Hầu hết các sản phẩm phần mềm sẽ liên quan đến một số loại xác thực người dùng để truy cập các tài nguyên được bảo vệ cho người dùng đó. Khi nói đến API, việc khách hàng thu thập thông tin đăng nhập của người dùng để gửi đến máy chủ của bạn là một thực tế tồi. Đây là nơi OAuth đến.
OAuth cung cấp nhiều lợi ích so với xác thực tên người dùng / mật khẩu của bên thứ ba. Trên hết, khách hàng không bao giờ có quyền truy cập vào thông tin đăng nhập của người dùng. Người dùng được chuyển hướng đến máy chủ của bạn khi họ đăng nhập. Sau khi người dùng đăng nhập vào trang web của bạn, họ sẽ được chuyển hướng trở lại máy khách nơi khách hàng sẽ nhận được mã thông báo truy cập để sử dụng trong các yêu cầu trong tương lai.
Một lợi ích quan trọng khác của việc sử dụng OAuth là khả năng hủy bỏ quyền truy cập của khách hàng bất cứ lúc nào. Nếu người dùng quyết định rằng, vì bất kỳ lý do gì, họ không còn muốn khách hàng có thể truy cập các tài nguyên được bảo vệ thay mặt họ, họ chỉ cần truy cập vào giao diện bạn đã tạo và hủy quyền truy cập của khách hàng.
Bắt đầu sớm
Một trong những điều quan trọng nhất bạn có thể làm để làm cho API của mình thành công là bắt đầu sớm. Khi bạn viết chức năng đó để tạo một số mục trong cơ sở dữ liệu của mình, hãy tiếp tục và dành thêm thời gian và viết giao diện API cho nó.Viết tài liệu tốt
Không có gì giết chết API nhanh hơn việc không có tài liệu tốt. Mặc dù một số nhà phát triển có thể sử dụng API tài liệu kém và tìm hiểu cách thức hoạt động của nó, hầu hết sẽ không muốn.
Bạn nên ghi lại mọi cuộc gọi API mà bạn có sẵn và phân loại các cuộc gọi API của bạn theo loại dữ liệu họ hành động. Cùng với việc ghi lại các điểm cuối cho chính các lệnh gọi API, bạn nên xác định một cách có hệ thống các đối số đầu vào bắt buộc và tùy chọn cũng như các cấu trúc dữ liệu đầu ra. Đối số đầu vào phải liệt kê một giá trị mặc định nếu có một giá trị và cũng chỉ ra định dạng dữ liệu dự kiến như số hoặc chuỗi. Cuối cùng, mọi lệnh gọi API phải có danh sách các điều kiện lỗi và mã trạng thái.
Để làm tròn tài liệu của bạn, hãy đảm bảo bao gồm một hoặc hai ví dụ cho các tình huống đầu vào và đầu ra chung cho mỗi lệnh gọi API.
Phát triển API: Giữ cho nó đơn giản
Mặc dù có vẻ như việc phát triển API là một nỗ lực phức tạp, ý tưởng về chính API không phải là một khái niệm mới và có một lượng lớn tài liệu có sẵn về mỗi chủ đề chúng tôi đã đề cập ở đây. Chỉ cần chắc chắn sử dụng các thực tiễn tốt nơi bạn có thể tìm thấy chúng, và để cung cấp một giao diện phù hợp, tài liệu tốt.
