Quy trình cộng tác

Hướng dẫn này phác thảo quy trình được khuyến nghị cho hoạt động cộng tác API trong Apidog, từ thiết kế ban đầu đến triển khai.

Tổng quan quy trình

Quy trình sau đây bảo đảm sự cộng tác suôn sẻ giữa các nhà thiết kế API, nhà phát triển và kỹ sư QA:

1. Soạn thảo tài liệu API

Nhà thiết kế API tạo tài liệu API ban đầu trong Apidog, xác định các endpoint, tham số, schema và phản hồi dự kiến.

2. Rà soát cộng tác

Nhà phát triển front-end và back-end cùng làm việc để rà soát và cải thiện tài liệu, bảo đảm sự thống nhất về:

Các trường hợp sử dụng và yêu cầu của API

Cấu trúc yêu cầu/phản hồi

Mô hình dữ liệu và schema

Xử lý lỗi

3. Khởi động phát triển với dữ liệu mock

Nhà phát triển front-end có thể bắt đầu phát triển ngay lập tức bằng cách sử dụng dữ liệu mock được tạo tự động dựa trên tài liệu API trong Apidog.

Lợi ích:

Không cần tạo quy tắc mock thủ công

Phát triển song song mà không cần chờ back-end hoàn thành

Cấu trúc dữ liệu thực tế phục vụ kiểm thử

4. Gỡ lỗi với các trường hợp sử dụng API

Nhà phát triển back-end gỡ lỗi API trong quá trình phát triển bằng cách sử dụng các trường hợp sử dụng đã được định nghĩa trước.

Tiêu chí hoàn thành:

Tất cả các trường hợp sử dụng đều vượt qua quá trình gỡ lỗi thành công

Mọi thay đổi được thực hiện trong quá trình phát triển sẽ tự động cập nhật đặc tả API

Bảo đảm việc bảo trì API kịp thời và tiết kiệm chi phí

5. Lưu các trường hợp endpoint

Sau khi hoàn tất gỡ lỗi, nhà phát triển back-end lưu các yêu cầu thành công dưới dạng trường hợp endpoint để phục vụ:

Kiểm thử trong tương lai

Tài liệu hóa các ví dụ hoạt động đúng

Tham chiếu cho QA

6. Kiểm thử API

Kỹ sư QA kiểm thử API trực tiếp bằng các trường hợp endpoint đã được định nghĩa trước, nhằm bảo đảm:

Tính đúng đắn về chức năng

Định dạng phản hồi dự kiến

Xử lý lỗi

Các trường hợp biên

7. Kiểm thử tích hợp

Sau khi tất cả API đã được phát triển, kỹ sư QA (hoặc nhà phát triển back-end) sử dụng tính năng bộ sưu tập kiểm thử để tiến hành kiểm thử tích hợp đa API một cách toàn diện.

Mục đích:

Xác minh quá trình gọi API hoạt động suôn sẻ

Kiểm thử các quy trình end-to-end

Xác thực luồng dữ liệu giữa các endpoint

8. Gỡ lỗi chung

Khi cả quá trình phát triển front-end và back-end đã hoàn tất:

Nhà phát triển front-end chuyển từ dữ liệu mock sang dữ liệu thực

Cả hai nhóm xác minh việc tích hợp hoạt động như mong đợi

Tuân thủ đặc tả API một cách cẩn trọng để bảo đảm tính tương thích

Lợi ích của quy trình này

Lợi ích	Mô tả
Phát triển song song	Nhóm front-end và back-end làm việc đồng thời
Giảm lỗi	Phát triển dựa trên đặc tả giúp giảm thiểu hiểu sai trong giao tiếp
Lặp nhanh hơn	Dữ liệu mock tự động và các bản cập nhật đặc tả giúp tăng tốc quá trình phát triển
Kiểm thử tốt hơn	Các trường hợp được định nghĩa trước và kiểm thử tích hợp bảo đảm chất lượng
Tài liệu rõ ràng	Tài liệu sống luôn được đồng bộ với quá trình triển khai

Quy trình cộng tác

Tổng quan quy trình#

1. Soạn thảo tài liệu API#

2. Rà soát cộng tác#

3. Khởi động phát triển với dữ liệu mock#

4. Gỡ lỗi với các trường hợp sử dụng API#

5. Lưu các trường hợp endpoint#

6. Kiểm thử API#

7. Kiểm thử tích hợp#

8. Gỡ lỗi chung#

Lợi ích của quy trình này#