Mô-đun APIs của Apidog có hai chế độ có thể chuyển đổi ở góc dưới bên trái của giao diện: Design-first Mode và Request-first Mode.Cả hai chế độ đều cung cấp các chức năng tương tự nhưng với giao diện khác nhau, đáp ứng các quy trình làm việc khác nhau của đội nhóm.Design-first Mode là chế độ được Apidog khuyến nghị, phù hợp với các đội nhóm tuân theo phương pháp API-Design First. Trong chế độ này, các đội nhóm đặc tả API trước, sau đó tiến hành phát triển và kiểm thử dựa trên đặc tả API.Mặt khác, Request-first Mode lý tưởng cho các đội nhóm ban đầu không định nghĩa đặc tả API. Các đội nhóm này thường tập trung vào phát triển backend, hoàn thiện mã, rồi sau đó tạo đặc tả API để bắt đầu kiểm thử và công việc phía client.Nếu bạn cần gọi các API do người khác phát triển nhưng không có tài liệu, bạn cũng nên sử dụng Request-first Mode.
Design-First Mode#
Trong Design-first Mode, việc chỉnh sửa đặc tả API và gửi yêu cầu được truy cập thông qua các tab riêng biệt. Người dùng sửa đổi đặc tả API trong tab Edit và gửi yêu cầu trong tab Run.Sự tách biệt này phù hợp với các đội nhóm tuân theo phương pháp API-Design First, trong đó kiến trúc sư API và nhà phát triển/người sử dụng API có các vai trò riêng biệt. Kiến trúc sư API định nghĩa đặc tả API mà không gửi yêu cầu, trong khi nhà phát triển tập trung vào phát triển và kiểm thử API mà không thay đổi đặc tả API.Các tab được phân chia phù hợp với thói quen sử dụng của những đội nhóm như vậy. Trong tab Edit, kiến trúc sư API có thể chỉ định các ví dụ yêu cầu, các ví dụ này sẽ tự động được đặt làm giá trị tham số mặc định trong tab Run. Nhà phát triển/người sử dụng API có thể tiếp tục sửa đổi giá trị tham số và request body trong tab Run.Request-First Mode#
Request-first Mode phù hợp với các đội nhóm không đặc tả API từ trước. Nhà phát triển backend trực tiếp làm việc trên quá trình phát triển API và có thể cần gọi API để gỡ lỗi trong quá trình phát triển.Trong chế độ này, nhà phát triển không cần đặc tả API ngay từ đầu; thay vào đó, họ có thể nhập trực tiếp một yêu cầu, tương tự như tạo một yêu cầu mới trong Postman. Trong giao diện này, nhà phát triển có thể dễ dàng sửa đổi loại tham số, tên, giá trị, các thành phần body, v.v. mà không cần điều chỉnh riêng đặc tả API và giá trị tham số yêu cầu.Sau khi hoàn tất gỡ lỗi và lưu lại, yêu cầu sẽ tự động được phân tích cú pháp thành một đặc tả endpoint. Các tham số được chuyển đổi thành tham số đặc tả và giá trị ví dụ, trong khi request/response body được phân tích cú pháp thành schema, và các giá trị body được diễn giải thành ví dụ request/response. Nhà phát triển có thể tiếp tục tinh chỉnh và nâng cao đặc tả endpoint này dựa trên yêu cầu của họ.Sự khác biệt giữa các chế độ#
Sự khác biệt chính giữa hai chế độ là trong Request-first Mode, request body được sử dụng làm ví dụ request body của endpoint. Ngược lại, trong Design-first Mode, người dùng có thể nhập một request body thực tế trong tab Run cùng với ví dụ request body. Do đó, phần body trong tab Run CHỈ khả dụng trong Design-first Mode và không hiển thị trong Request-first Mode.Một điểm khác biệt nữa là trong Design-first Mode, bạn có thể thêm pre/post-processor ở cấp đặc tả endpoint hoặc ở cấp run/endpoint case. Trong khi đó, trong Request-first Mode, vì không có tab Run, tất cả pre/post-processor được xem là ở cấp đặc tả endpoint. Các pre/post-processor ở cấp run/endpoint case sẽ không hiển thị trong Request-first Mode. 