Xây dựng và cấu hình công cụ

Bắt đầu với tài liệu API chính thức cho dịch vụ kinh doanh và một nhiệm vụ mà tài khoản của bạn được phép thực hiện. Một công cụ hẹp, được mô tả tốt sẽ dễ dàng hơn để kiểm tra hơn là một công cụ chung chấp nhận một URL và phương pháp tùy ý.

Định nghĩa yêu cầu#

Cho công cụ một tên ổn định và mô tả giải thích mục đích của nó, giới hạn quan trọng và liệu nó có thay đổi dữ liệu hay không. Chọn phương pháp HTTP được ghi chép và điểm kết thúc. Chỉ dùng các dấu đứng cho các yếu tố đường dẫn biến mà thao tác thực sự cho phép.

Đối với một tìm kiếm ghi chép hư cấu, đường dẫn có thể chứa một nhận dạng ghi chép. Tên máy và vùng tài khoản nên là một phần của kết nối cấu hình thay vì là đầu vào mô hình mở.

Định nghĩa và vẽ đầu vào#

Dùng sơ đồ nhập để mô tả mỗi trường, kiểu của nó, trạng thái cần thiết và giá trị hợp lệ. Một sơ đồ nhỏ cho một tìm kiếm hư cấu là:

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

Đặt các đối số vào đường dẫn, câu hỏi hay các trường cơ thể được ghi chép. Kiểm tra xem các trường cần thiết thiếu và các đối số bổ sung không mong đợi đã bị thất bại rõ ràng. Giữ xác thực trong kết nối máy chủ được hỗ trợ, không phải trong một lời mời, mô hình ví dụ hay đầu công cụ mã hóa cứng.

Hình dạng kết quả#

Bản đồ đáp ứng hay biến đổi có thể trả lại các trường mà luồng công việc cần thay vì toàn bộ đáp ứng dịch vụ. Kiểm tra kết quả biến đổi so với kết quả thử nghiệm ban đầu. Đừng gỡ bỏ ký hiệu nhận dạng ghi chú, thông tin trang hoặc chi tiết lỗi cần thiết để hiểu liệu kết quả có hoàn chỉnh hay không.

Xem lại các thiết lập hoạt động#

Cấu hình công cụ hỗ trợ các thiết lập thời gian chờ, bộ nhớ đệm và thử lại. Chỉ dùng bộ nhớ đệm khi có thể chấp nhận dữ liệu cũ; kết quả đọc từ bộ nhớ đệm không phù hợp để làm bằng chứng cuối cùng rằng thao tác ghi vừa hoàn tất. Thử lại một thao tác ghi không có tính lũy đẳng có thể tạo dữ liệu trùng lặp, vì vậy hãy chọn cách thử lại dựa trên những bảo đảm được nêu trong tài liệu API.

Kiểm tra đường dẫn thực#

Kiểm tra nhập đúng, nhập sai, kết quả rỗng, lỗi quyền và một cuộc gọi thành công có giới hạn. Chẩn đoán thử có thể chứa thông tin yêu cầu nhạy cảm; chỉ kiểm tra chúng qua đường dẫn quản trị viên được chấp thuận và chỉnh sửa trước khi chia sẻ. Xem thử nghiệm trước khi khách hàng sử dụng công cụ.