H&atilde;y c&ugrave;ng Tek.4 kh&aacute;m ph&aacute; 3 mẹo hay về API response.
<h2 style="text-align: justify;">Lu&ocirc;n trả về một đối tượng</h2>
Khi x&acirc;y dựng một API trả về một gi&aacute; trị duy nhất, bạn c&oacute; thể bị c&aacute;m dỗ để tuần tự h&oacute;a n&oacute; trực tiếp, như sau:
<pre class="language-python"><code>["Maria", "John", "Laura"]</code></pre>
Đ&acirc;y thực sự l&agrave; một phản hồi JSON hợp lệ, v&igrave; n&oacute; sẽ l&agrave;:
<ul style="text-align: justify;">
<li style="font-weight: 400;" aria-level="1">một chuỗi (v&iacute; dụ: <code>"Hello world"</code>)</li>
<li style="font-weight: 400;" aria-level="1">một số (v&iacute; dụ: <code>1</code>)</li>
<li style="font-weight: 400;" aria-level="1">một boolean (v&iacute; dụ: <code>true</code>)</li>
<li style="font-weight: 400;" aria-level="1"><code>null</code></li>
</ul>
Bạn c&oacute; thể muốn l&agrave;m điều n&agrave;y để giữ cho phản hồi API sạch sẽ v&agrave; đơn giản, nhưng c&aacute;ch tiếp cận như thế thực sự kh&ocirc;ng tốt.&nbsp;
Giả sử bạn cần l&agrave;m cho API đ&oacute; trả về nhiều hơn một gi&aacute; trị nhưng bạn kh&ocirc;ng thể biết API của m&igrave;nh sẽ cần ph&aacute;t triển như thế n&agrave;o để đ&aacute;p ứng nhu cầu trong tương lai. Trong trường hợp n&agrave;y, bạn sẽ phải thay đổi ho&agrave;n to&agrave;n API response bằng c&aacute;ch buộc phải biến n&oacute; th&agrave;nh một đối tượng.
V&iacute; dụ: Đ&acirc;y l&agrave; c&aacute;ch phản hồi mới:
<pre class="language-python"><code>{ 
 "result": ["Maria", "John", "Laura"], 
 "averageAge": 37
}</code></pre>
Thay đổi nhỏ n&agrave;y sẽ buộc bất kỳ lập tr&igrave;nh vi&ecirc;n n&agrave;o đ&atilde; gọi API đ&oacute; phải cập nhật m&atilde; của họ cho ph&ugrave; hợp. Điều n&agrave;y l&agrave; do mảng được API trả về ban đầu hiện được lưu trữ trong trường kết quả, kh&ocirc;ng xuất hiện trong phản hồi cũ.
Vấn đề nằm ở phản hồi API ban đầu, phải lu&ocirc;n l&agrave; một đối tượng. Đặc biệt, bằng c&aacute;ch tạo ra một phản hồi như sau, kh&ocirc;ng lập tr&igrave;nh vi&ecirc;n n&agrave;o sẽ phải thay đổi logic của họ khi một trường mới được th&ecirc;m v&agrave;o.
<pre class="language-python"><code>{
 "result": ["Maria", "John", "Laura"]
}</code></pre>
&nbsp;
<h1 style="text-align: justify;">C&oacute; c&aacute;c định dạng dữ liệu kh&aacute;c ngo&agrave;i JSON</h1>
JSON l&agrave; định dạng dữ liệu bạn thường muốn sử dụng. Đồng thời, bạn phải nhớ rằng c&oacute; nhiều loại MIME m&agrave; ti&ecirc;u đề HTTP loại Nội dung c&oacute; thể sử dụng. application / json kh&ocirc;ng phải l&agrave; c&aacute;i duy nhất c&oacute; sẵn.
Về chi tiết, bạn c&oacute; thể được y&ecirc;u cầu truy xuất một số dữ liệu v&agrave; tạo tệp văn bản thuần t&uacute;y hoặc tệp c&oacute; cấu tr&uacute;c, chẳng hạn như tệp CSV.&nbsp;
Trong trường hợp như vậy, c&aacute;ch tiếp cận c&oacute; thể l&agrave; ph&aacute;t triển một API trả về dữ liệu được y&ecirc;u cầu trong JSON. Sau đ&oacute;, h&atilde;y để người gọi xử l&yacute; qu&aacute; tr&igrave;nh chuyển đổi n&oacute; sang định dạng mong muốn. Mặc d&ugrave; kh&ocirc;ng c&oacute; sai lầm n&agrave;o ở hướng tiếp cận n&agrave;y, nhưng n&oacute; kh&ocirc;ng phải l&agrave; c&aacute;ch tốt nhất.
Bạn kh&ocirc;ng n&ecirc;n t&aacute;ch qu&aacute; tr&igrave;nh truy xuất dữ liệu khỏi qu&aacute; tr&igrave;nh chuyển đổi dữ liệu, chỉ để giữ cho API của bạn chuẩn hơn. V&igrave; bạn c&oacute; thể trả về trực tiếp dữ liệu c&oacute; cấu tr&uacute;c ở định dạng mong muốn, bạn n&ecirc;n ph&aacute;t triển một API t&ugrave;y chỉnh để đạt được điều n&agrave;y.
Mặc d&ugrave; API n&agrave;y c&oacute; vẻ kh&aacute;c thường so với c&aacute;c API kh&aacute;c, nhưng n&oacute; sẽ phục vụ nhu cầu của bạn một c&aacute;ch đơn giản. Ngo&agrave;i ra, to&agrave;n bộ logic đặt tại nơi thanh lịch hơn v&agrave; dễ bảo tr&igrave; hơn.
&nbsp;
<h1 style="text-align: justify;">Kh&ocirc;ng bỏ qua gi&aacute; trị null</h1>
Như đ&atilde; n&ecirc;u trong ti&ecirc;u chuẩn ECMA-404, null l&agrave; một gi&aacute; trị JSON hợp lệ.
Một gi&aacute; trị c&oacute; thể l&agrave; một chuỗi trong dấu ngoặc k&eacute;p hoặc một số hoặc đ&uacute;ng hoặc sai hoặc null, hoặc một đối tượng hoặc một mảng - Giới thiệu JSON
C&aacute;c lập tr&igrave;nh vi&ecirc;n thường bị c&aacute;m dỗ lọc tất cả c&aacute;c gi&aacute; trị rỗng khỏi phản hồi của họ để l&agrave;m cho ch&uacute;ng nhẹ hơn. Điều n&agrave;y vốn dĩ kh&ocirc;ng sai, đặc biệt nếu ưu ti&ecirc;n hiệu suất v&agrave; sử dụng mạng. Tr&ecirc;n thực tế, JSON c&agrave;ng lớn th&igrave; c&agrave;ng cần nhiều thời gian để tải xuống v&agrave; sau đ&oacute; ph&acirc;n t&iacute;ch c&uacute; ph&aacute;p.
Mặt kh&aacute;c, bỏ qua c&aacute;c gi&aacute; trị null khỏi phản hồi JSON của bạn kh&ocirc;ng n&ecirc;n l&agrave; c&aacute;ch tiếp cận ưa th&iacute;ch.
Đầu ti&ecirc;n, v&igrave; gi&aacute; trị null v&agrave; missing c&oacute; hai &yacute; nghĩa kh&aacute;c nhau trong JSON. Đầu ti&ecirc;n c&oacute; nghĩa l&agrave; "kh&ocirc;ng c&oacute; gi&aacute; trị", trong khi thứ hai c&oacute; nghĩa l&agrave; "kh&ocirc;ng c&oacute; gi&aacute; trị nhất định". Cụ thể, đ&acirc;y l&agrave; sự kh&aacute;c biệt giống nhau giữa null v&agrave; undefined, nếu bạn đ&atilde; quen với JavaScript. Sự kh&aacute;c biệt l&agrave; nhỏ, nhưng việc ph&acirc;n biệt giữa hai sắc th&aacute;i n&agrave;y c&oacute; thể l&agrave; rất quan trọng.
Thứ hai, trả về một phản hồi c&oacute; c&aacute;c trường thay đổi dựa tr&ecirc;n gi&aacute; trị của ch&uacute;ng c&oacute; thể dễ d&agrave;ng g&acirc;y nhầm lẫn cho c&aacute;c lập tr&igrave;nh vi&ecirc;n đang gọi API. L&yacute; do l&agrave; c&aacute;c API phải lu&ocirc;n nhất qu&aacute;n trong phản hồi của ch&uacute;ng. Kh&ocirc;ng tu&acirc;n thủ nguy&ecirc;n tắc n&agrave;y c&oacute; thể dễ d&agrave;ng dẫn đến thất vọng v&agrave; cũng l&agrave;m cho qu&aacute; tr&igrave;nh gỡ lỗi phức tạp hơn.
Thứ ba, c&aacute;c gi&aacute; trị bị thiếu dẫn đến sự kh&ocirc;ng chắc chắn kh&ocirc;ng cần thiết. Nh&agrave; ph&aacute;t triển gọi API c&oacute; thể sẽ thắc mắc tại sao một số trường lại bị bỏ qua. V&igrave; việc t&igrave;m hiểu xem đ&oacute; c&oacute; phải l&agrave; cố &yacute; hay kh&ocirc;ng c&oacute; thể kh&ocirc;ng dễ d&agrave;ng, điều n&agrave;y sẽ dẫn đến những nghi ngờ kh&ocirc;ng mong muốn.
&nbsp;
<h1 style="text-align: justify;">Kết luận</h1>
Việc t&igrave;m kiếm phản hồi ph&ugrave; hợp cho API của bạn rất kh&oacute; v&agrave; c&ograve;n phụ thuộc v&agrave;o nhu cầu của bạn. Tuy nhi&ecirc;n, c&oacute; một số mẹo c&oacute; thể cho ph&eacute;p bạn tr&aacute;nh những rắc rối trong tương lai vốn l&agrave; hậu quả của những quyết định chưa ch&iacute;nh x&aacute;c cũ.&nbsp;
B&agrave;i viết đ&atilde; đề cập đến 3 mẹo quan trọng nhất về API response được c&aacute;c lập tr&igrave;nh vi&ecirc;n cấp cao c&ocirc;ng nhận v&agrave; sử dụng th&agrave;nh c&ocirc;ng trong một khoảng thời gian d&agrave;i.
Cảm ơn bạn đ&atilde; d&agrave;nh thời gian đọc! Hy vọng rằng bạn thấy th&ocirc;ng tin n&agrave;y hữu &iacute;ch. Đừng ngần ngại li&ecirc;n hệ nếu bạn c&oacute; bất kỳ c&acirc;u hỏi, nhận x&eacute;t hay đề xuất n&agrave;o nh&eacute;.

Admin

3 mẹo xử lý API responses dành cho Backend Developers

Cùng tác giả

Admin

Có liên quan