Tutorial

Với RakAPIt, bạn có thể thực hiện API testing đơn giản từ tạo Test case cho đến thực thi test. Bạn có thể hiểu được API testing như thế nào ở RakAPIt thông qua các bước hướng dẫn dưới đây.

1. Tạo Project

Đầu tiên, tạo một project mới. Bạn có thể nhập tệp OpenAPI (2.0 & 3.0)vào project của mình. Từ định nghĩa API trong OpenAPI, bạn có thể dễ dàng tạo ra một Test Object.

Lần này sử dụng RakAPIt Cars API.

  • Step 1: Click vào thẻ Create a Project.
  • Step 2: Nhập tên Project.
  • Step 3: Nhập mô tả
  • Step 4: Tải lên tệp Swagger
    Dán url của file RakAPIt Cars API Swagger vào ô nhập liệu để lấy dữ liệu từ swagger。
  • Step 5: Nhấn vào nút 「OK」

displayProject
Tạo Project

2. Tạo Test Object

Tiếp theo, tiến hành tạo Test Object.

  • Bước 1: Nhấn nút「+ Test Object」để tạo Test Object.
    Chọn Operation hiện có từ "Swagger Operation". Nhấn định nghĩa API trong mục "Swagger Operation" mà bạn muốn sử dụng.
    Lần này, sử dụng GET cas/{id}/json ở trang thứ 2.

    displayProject
    Tạo Test Object

  • Bước 2: Chọn các Parameter bạn muốn sử dụng hoặc nhấn nút Skipđể sử dụng tất cả các parameter
  • Bước 3: Nhập các thông tin cơ bản của Request theo từng Step.
    Nhập những thông tin cần thiết cho Method, API Endpoint, Header và Body. Trường hợp tham chiếu đinh nghĩa Swagger, các tham số sẽ được điền tự động mà không cần nhập thủ công.
    Lần này, nhập thông tin cần thiết đã được nhập vào để tạo Test Object dựa vào file Swagger.
    Đối với mỗi tham số, hãy nhập các mẫu dữ liệu mà người dùng muốn test. Trường hợp tham chiếu định nghĩa Swagger, các mẫu dữ liệu có thể được sinh tự động bằng cách thực hiện các bước dưới đây:
    1. Nhấn vào nút 「>>」(Tạo mẫu dữ liệu)
    2. Chọn tham số muốn tạo dữ liệu. Lần này chọn id.
    3. Nhấn vào nút 「OK」.

    find_test_object Tạo mẫu dữ liệu

  • Bước 4: Chọn Phương thức kết hợp.
  • Bước 5: Nhấn vào nút Create Test cases.

3. Thực thi Test case

Tiến hành thực thi Test case. Có thể thực thi Test case tại 「Test case table」hoặc「Test case detail」

  • Thực thi Test case tại Test case detail
    • Step 1: Mở modal Test case detail.
    • Step 2-1: Nhấn nút 「Send & Save Result」để thực thi và lưu kết quả của Test case, hoặc nhấn 「Send」để thực thi Test case mà không lưu kết quả.

      run

    • Step 2-2: Trường hợp muốn lưu kết quả thực thi sau khi nhấn「Send」nhấn nút 「Save Result」

      run

    • Step 3: Kiểm tra kết quả thực thi tại modal Test case detail.
  • Thực thi Test case tại Test case table
    • Bước 1: Chọn Test case để thực thi.
    • Bước 2: Nhấn nút Send & Save Result.
    • Bước 3: Kiểm tra kết quả test ở danh sách Test case.

      result Màn hình Test case

4. Tạo tự động Test case

Có thể tạo nhiều Test case một cách tự động bằng chức năng Generate Test cases.

Để sử dụng chức năng Generate Test cases, nhấn nút 「Generate Test cases」tại tab "By Response Code" hoặc 「Generate Test cases」tại mục 「More」ở tab "By Test Suite".

add_testcase

RakAPIt cung cấp 5 phương pháp tạo tự động Test case. Lần này, chúng tôi sẽ giới thiệu cách sinh test case tự động bằng OpenAI

  • Step 1: Chọn phương thức Generate Test cases by OpenAIở chức năng 「Generate Test cases」hoặc nhấn nút 「Generate Test cases by OpenAI」 để mở modal Generate Test cases by OpenAI.
  • add_testcase
    Mở modal "Generate Test cases by OpenAI"

    add_testcase_openai
    Modal Generate Test cases by OpenAI

  • Step 2: Chọn parameters (1-1) và response code(1-2) bạn muốn tập trung vào.
  • Step 3: Nhấn nút 「Generate suggestions of test cases」(2).
  • Step 4: Chọn các test case bạn muốn tạo sau đó nhấn nút 「Add Test Cases」(3).

Bạn có thể thực hiện theo trình tự các bước từ tạo Test case cho đến thực thi test. Vui lòng tham khảo cách sử dụng chi tiết ở các mục đăng tải.