Werner Vogels – 6 bài học rút ra để thiết kế API tốt
(aws.amazon.com)- Ghi chú về "6 nguyên tắc để tạo ra API tốt mà AWS đã học được trong 15 năm"
-
API là vĩnh viễn!
-
Hãy giữ khả năng tương thích ngược.
-
Hãy xây dựng ngược từ các trường hợp sử dụng của khách hàng.
-
Hãy tạo API có lỗi được thể hiện rõ ràng.
-
Hãy tạo API mà có thể hiểu ngay mục đích và cách dùng.
-
Hãy chú ý để không làm rò rỉ các chi tiết triển khai.
-
Những sai lầm thường mắc phải trong thiết kế API ban đầu
-
Tạo API có khả năng mở rộng cao với Smithy
4 bình luận
Tôi thấy điểm số 5 rất thấm.
Tôi từng xem bài "Liệu một REST API như vậy đã ổn chưa" được tham chiếu ở đây, và thấy rất hay: https://tv.naver.com/v/2292653
Bình thường tôi không quá để ý đến kiểu thông tin semantic này, nhưng nhìn vào Github API thì thấy họ cũng trả về rất đầy đủ những thông tin như vậy, nên có cảm giác là nó được làm rất tốt.
Có vẻ là một nội dung hay.
Đặc biệt, mục 1 và 4 có lẽ là những điểm tôi luôn nhắc đến khi review.
Mục 3 dường như cũng có điểm tương đồng với câu Joshua Bloch từng nói: "Write to Your API Early and Often". (https://www.youtube.com/watch?v=aAb7hSCtvGw)
Khi được tổng hợp lại như thế này thì trông có vẻ hiển nhiên, nhưng rồi đến lúc thực sự làm thì lại cảm thấy mình vẫn lặp đi lặp lại những sai lầm đó.