Mẫu template mô tả hiệu quả cho một API

Nếu như ai làm trong ngành phần mềm ngày nay thì chắc hẵn không còn lạ lẫm với việc dùng API cho công việc hằng ngày. Tuy nhiên, để có thể mô tả một API cho đồng nghiệp, đối tác hiểu và sử dụng lại được thì cũng là một bài toán thú vị. Trong bài viết này, mình sẽ đưa ra một mẫu mô tả tài liệu API mà mình đã áp dụng trong dự án mình đang làm và thấy hiệu quả cho các bạn để tham khảo.  Theo mình một mô tả API hiệu quả thì nó phải đáp ứng được các tiêu chí sau: Dễ đọc, và dễ hiểu Có thể lấy sử dụng liền được Có thể dễ dàng cập nhật Do vậy những thành phần trong 1 mô tả sẽ gồm những phần sau: Một môt tả ngắn gọn về chức năng của API URI của API đó và ý nghĩa từng thành phần trong URI đó Method của API đó là gì API đó có header gì? Request body Response Sample cURL Ví dụ dưới đây là API cho việc tạo mới một học sinh vô trong danh sách học sinh của 1 trường Description Create new student Specification URI /create HTTP Method POST Required HTTP Headers Authorization Caller-Id Channel Content-Type […]

Bạn sẽ test như thế nào nếu được đưa 1 API?

Có thể câu trả lời của mọi người là Trời ơi, nó dễ ẹc mà. Ai mà chẳng test được. Nhưng có bao nhiêu người đã từng nghĩ là làm thế nào để test API cho đúng, cho đủ, phòng tránh và hạn chế ít nhất những sai lầm tới product. Trong bài này tôi […]

Tester nên nói gì trong Daily Standup Meeting

Hey, mọi người trong chúng ta đều chắc hẳn đã tham gia standup meeting. Một buổi meeting sẽ kéo dài khoảng 15 phút. Vậy có ai cảm thấy chán vì không biết nói gì hay là cảm thấy áp lực và lo lắng nếu như sếp bất chợt hỏi đến mình. Thật ra, mình cũng […]

Cách tìm ra lời giải thích tốt nhất cho 1 con bug

Hey, trong số chúng ta – những người tester, khi tìm ra một điều bất thường của softwate thì thường tạo ra bug ngay lập tức. Vậy có ai đã bị trường hợp Dev kêu lại và hỏi 1 câu rằng: Anh không nghĩ nó là bug, anh không bị trong một số trường hợp […]

Big salary is much more important than job satisfaction

As the society grows, money is becoming more important nowadays. Having money may not make you happy, but having no money will make you miserable. Thus, most people believe that the wage is the main factor of making the decision for a career. However, in my opinion, I strongly believe job satisfaction is more important […]

Tại sao Testing là cần thiết? Testing để làm gì?

Tại sao Testing là cần thiết? Testing để làm gì? Khi mình đưa ra câu hỏi này tới một số người thì câu trả lời sẽ là có và cần thiết. Và họ đưa ra một số lí do như: Nếu không test thì ai là người đảm bảo những yêu cầu của khách hàng […]

JavaScript : Compare two arrays

Conditions : You have a arrays by structure with following : array1 : [ {“Name” : “John”, “Age”: “24”}, {“Name”: “Kata”, “Age”: “25} ] You have another arrays by structure with following: array1 : [ {“Name”: “Kata”, “Age”: “25} {“Name” : “John”, “Age”: “24”}, ] Expected : You want to compare equals 2 this arrays […]