Tùy chọn Apidog CLI

Apidog CLI được sử dụng để chạy kiểm thử tự động và quản lý tài nguyên dự án Apidog từ terminal hoặc pipeline CI/CD. Công cụ này hỗ trợ thực thi kiểm thử, quản lý tài nguyên thiết kế API, môi trường và biến, nhập và xuất, xuất bản tài liệu, cộng tác theo nhánh và quản trị dự án.

Cú pháp Apidog CLI cơ bản

Hầu hết các lệnh tài nguyên dự án sử dụng --project <projectId> để chỉ định dự án. Bạn có thể sử dụng --branch <branchName> để thao tác trên một nhánh cụ thể. Nếu bỏ qua --branch, máy chủ sẽ sử dụng nhánh mặc định.

Xác thực

Trước khi truy cập các dự án riêng tư, hãy đăng nhập hoặc cung cấp access token.

Lệnh	Mô tả	Ví dụ
`login`	Đăng nhập bằng access token và lưu cục bộ.	`apidog login --with-token <token>`
`logout`	Đăng xuất và xóa token cục bộ đã lưu.	`apidog logout`
`whoami`	Hiển thị thông tin về người dùng hiện đang được xác thực.	`apidog whoami`

Bạn cũng có thể truyền token trực tiếp khi chạy lệnh:

Nếu bạn đang sử dụng GitHub Actions, bạn có thể lưu access token trong Settings --> Secrets and Variables --> Actions --> Repository variables của repository. Sau đó sử dụng ${{ vars.APIDOG_ACCESS_TOKEN }} để tham chiếu token đó.

CLI Schema

Sử dụng cli-schema để kiểm tra và xác thực các tệp JSON trước khi tạo hoặc cập nhật các tài nguyên phức tạp. Điều này giúp giảm lỗi yêu cầu do dữ liệu không đúng định dạng.

Lệnh	Mô tả	Ví dụ
`cli-schema list`	Liệt kê tất cả các khóa schema được CLI hỗ trợ.	`apidog cli-schema list`
`cli-schema get`	In JSON Schema cho tệp dữ liệu của một lệnh.	`apidog cli-schema get endpoint-create`
`cli-schema validate`	Xác thực tệp JSON cục bộ theo một khóa schema.	`apidog cli-schema validate endpoint-create --file ./endpoint.json`

Các khóa schema thường kết hợp đường dẫn lệnh và hành động, chẳng hạn như endpoint-create, test-scenario-update và merge-request-create.

Nhóm và dự án

Các lệnh nhóm và dự án là điểm bắt đầu để quản lý tài nguyên thông qua CLI. Sử dụng chúng để tìm các ID cần thiết cho các lệnh cấp dự án.

Quản lý nhóm

Lệnh	Mô tả	Ví dụ
`team list`	Liệt kê các nhóm mà tài khoản hiện tại có thể truy cập.	`apidog team list`
`team get`	Xem chi tiết của một nhóm cụ thể.	`apidog team get <teamId>`

Quản lý dự án

Lệnh	Mô tả	Ví dụ
`project list`	Liệt kê các dự án mà tài khoản hiện tại có thể truy cập.	`apidog project list`
`project get`	Xem chi tiết dự án.	`apidog project get <projectId>`
`project create`	Tạo một dự án trong một nhóm.	`apidog project create --team <teamId> --name "New Project"`

Cài đặt dự án

Lệnh	Mô tả	Ví dụ
`project settings get`	Xem cài đặt cấp dự án.	`apidog project settings get --project <projectId>`
`project settings update`	Cập nhật cài đặt dự án bằng tệp JSON.	`apidog project settings update --project <projectId> --file ./project-settings.json`
`cli-schema get project-settings-update`	Xem schema cho cập nhật cài đặt dự án.	`apidog cli-schema get project-settings-update`

Môi trường và biến

Sử dụng các lệnh này để quản lý môi trường runtime, biến toàn cục và biến nhóm được sử dụng bởi gỡ lỗi API và kiểm thử tự động.

Quản lý môi trường

Lệnh	Mô tả	Ví dụ
`environment list`	Liệt kê các môi trường trong một dự án.	`apidog environment list --project <projectId>`
`environment get`	Xem chi tiết môi trường, chẳng hạn như base URL.	`apidog environment get <environmentId> --project <projectId>`
`environment create`	Tạo một môi trường.	`apidog environment create <name> --project <projectId> --base-url <url>`
`environment update`	Cập nhật một môi trường.	`apidog environment update <environmentId> --project <projectId> --file ./environment.json`
`environment delete`	Xóa một môi trường.	`apidog environment delete <environmentId> --project <projectId>`
`cli-schema get environment-update`	Xem schema cho cập nhật môi trường.	`apidog cli-schema get environment-update`

Quản lý biến

Lệnh	Mô tả	Ví dụ
`variables list`	Liệt kê biến theo phạm vi.	`apidog variables list --project <projectId> --scope global`
`variables get`	Xem giá trị của một biến.	`apidog variables get --project <projectId> --scope global --key <key>`
`variables set`	Tạo hoặc cập nhật một biến.	`apidog variables set --project <projectId> --scope global --key <key> --value <value>`
`variables delete`	Xóa một biến.	`apidog variables delete --project <projectId> --scope global --key <key>`
`variables import`	Nhập biến từ một tệp cục bộ.	`apidog variables import --project <projectId> --scope global --file ./variables.json`
`variables export`	Xuất biến ra một tệp cục bộ.	`apidog variables export --project <projectId> --scope global --output ./variables.json`

Tài nguyên thiết kế API

Sử dụng các lệnh này để quản lý tài nguyên thiết kế API, bao gồm các endpoint HTTP API, schema, thư mục, quy tắc mock, tham số chung, thành phần phản hồi và security scheme. Khi tạo hoặc cập nhật tài nguyên phức tạp, bạn nên chạy cli-schema get <schemaKey> và cli-schema validate <schemaKey> --file <path> trước.

Endpoint HTTP API

Lệnh	Mô tả	Ví dụ
`endpoint list`	Liệt kê các endpoint HTTP API trong một dự án.	`apidog endpoint list --project <projectId>`
`endpoint get`	Xem chi tiết endpoint.	`apidog endpoint get <endpointId> --project <projectId>`
`endpoint create`	Tạo một endpoint từ tệp JSON.	`apidog endpoint create --project <projectId> --file ./endpoint.json`
`endpoint update`	Cập nhật một endpoint.	`apidog endpoint update <endpointId> --project <projectId> --file ./endpoint.json`
`endpoint delete`	Xóa một endpoint.	`apidog endpoint delete <endpointId> --project <projectId>`
`cli-schema get endpoint-create`	Xem schema cho việc tạo endpoint.	`apidog cli-schema get endpoint-create`
`cli-schema get endpoint-update`	Xem schema cho cập nhật endpoint.	`apidog cli-schema get endpoint-update`

Schema dữ liệu

Lệnh	Mô tả	Ví dụ
`schema list`	Liệt kê các schema dữ liệu trong một dự án.	`apidog schema list --project <projectId>`
`schema get`	Xem chi tiết schema.	`apidog schema get <schemaId> --project <projectId>`
`schema create`	Tạo một schema dữ liệu từ tệp JSON.	`apidog schema create --project <projectId> --file ./schema.json`
`schema update`	Cập nhật một schema dữ liệu.	`apidog schema update <schemaId> --project <projectId> --file ./schema.json`
`schema delete`	Xóa một schema dữ liệu.	`apidog schema delete <schemaId> --project <projectId>`
`cli-schema get schema-create`	Xem schema cho việc tạo schema dữ liệu.	`apidog cli-schema get schema-create`
`cli-schema get schema-update`	Xem schema cho cập nhật schema dữ liệu.	`apidog cli-schema get schema-update`

Tài liệu Markdown

Lệnh	Mô tả	Ví dụ
`doc list`	Liệt kê tài liệu Markdown.	`apidog doc list --project <projectId>`
`doc get`	Xem chi tiết tài liệu Markdown.	`apidog doc get <docId> --project <projectId>`
`doc create`	Tạo một tài liệu Markdown.	`apidog doc create --project <projectId> --file ./doc.json`
`doc update`	Cập nhật một tài liệu Markdown.	`apidog doc update <docId> --project <projectId> --file ./doc.json`
`doc delete`	Xóa một tài liệu Markdown.	`apidog doc delete <docId> --project <projectId>`

Thư mục tài nguyên

Sử dụng các lệnh folder để quản lý cây thư mục cho các loại tài nguyên khác nhau. Tùy chọn --type chọn loại tài nguyên, chẳng hạn như endpoint, schema, test-scenario, response-component, security-scheme, test-suite hoặc test-data.

Lệnh	Mô tả	Ví dụ
`folder list`	Liệt kê thư mục theo loại tài nguyên.	`apidog folder list --project <projectId> --type endpoint`
`folder create`	Tạo một thư mục theo loại tài nguyên.	`apidog folder create --project <projectId> --type endpoint --name "New Folder"`
`folder move`	Di chuyển một thư mục sang thư mục cha khác.	`apidog folder move <folderId> --project <projectId> --type endpoint --parent <parentId>`
`folder update`	Cập nhật tên thư mục, mô tả hoặc thư mục cha.	`apidog folder update <folderId> --project <projectId> --type endpoint --name "New Folder Name"`
`folder delete`	Xóa một thư mục.	`apidog folder delete <folderId> --project <projectId> --type endpoint`
`cli-schema get folder-create`	Xem schema cho việc tạo thư mục.	`apidog cli-schema get folder-create`
`cli-schema get folder-update`	Xem schema cho cập nhật thư mục.	`apidog cli-schema get folder-update`

--type chọn loại thư mục tài nguyên. Đây không phải là tên thư mục. Trường description chỉ được hỗ trợ cho thư mục endpoint và test-scenario; các loại thư mục khác chỉ hỗ trợ cập nhật tên và thư mục cha.

Quy tắc mock

Lệnh	Mô tả	Ví dụ
`mock list`	Liệt kê các quy tắc mock trong một dự án hoặc dưới một endpoint.	`apidog mock list --project <projectId> --http-api-id <endpointId>`
`mock get`	Xem một quy tắc mock.	`apidog mock get <mockId> --project <projectId>`
`mock create`	Tạo một quy tắc mock từ tệp JSON.	`apidog mock create --project <projectId> --file ./mock.json`
`mock update`	Cập nhật một quy tắc mock.	`apidog mock update <mockId> --project <projectId> --file ./mock.json`
`mock delete`	Xóa một quy tắc mock.	`apidog mock delete <mockId> --project <projectId>`
`cli-schema get mock-create`	Xem schema cho việc tạo quy tắc mock.	`apidog cli-schema get mock-create`
`cli-schema get mock-update`	Xem schema cho cập nhật quy tắc mock.	`apidog cli-schema get mock-update`

Tham số chung

Lệnh	Mô tả	Ví dụ
`common-parameter list`	Liệt kê các tham số chung có thể tái sử dụng.	`apidog common-parameter list --project <projectId>`
`common-parameter get`	Xem chi tiết tham số chung.	`apidog common-parameter get <commonParameterId> --project <projectId>`
`common-parameter create`	Tạo một tham số chung từ tệp JSON.	`apidog common-parameter create --project <projectId> --file ./common-parameter.json`
`common-parameter update`	Cập nhật một tham số chung.	`apidog common-parameter update <commonParameterId> --project <projectId> --file ./common-parameter.json`
`common-parameter import`	Nhập tham số chung từ một tệp.	`apidog common-parameter import --project <projectId> --file ./common-parameters.json`
`common-parameter export`	Xuất tham số chung ra một tệp cục bộ.	`apidog common-parameter export --project <projectId> --output ./common-parameters.json`

Thành phần phản hồi

Lệnh	Mô tả	Ví dụ
`response-component list`	Liệt kê các thành phần phản hồi có thể tái sử dụng.	`apidog response-component list --project <projectId>`
`response-component get`	Xem chi tiết thành phần phản hồi.	`apidog response-component get <responseComponentId> --project <projectId>`
`response-component create`	Tạo một thành phần phản hồi từ tệp JSON.	`apidog response-component create --project <projectId> --file ./response-component.json`
`response-component update`	Cập nhật một thành phần phản hồi.	`apidog response-component update <responseComponentId> --project <projectId> --file ./response-component.json`
`response-component delete`	Xóa một thành phần phản hồi.	`apidog response-component delete <responseComponentId> --project <projectId>`

Security scheme

Lệnh	Mô tả	Ví dụ
`security-scheme list`	Liệt kê các security scheme trong một dự án.	`apidog security-scheme list --project <projectId>`
`security-scheme get`	Xem chi tiết security scheme.	`apidog security-scheme get <schemeId> --project <projectId>`
`security-scheme create`	Tạo một security scheme từ tệp JSON.	`apidog security-scheme create --project <projectId> --file ./scheme.json`
`security-scheme update`	Cập nhật một security scheme.	`apidog security-scheme update <schemeId> --project <projectId> --file ./scheme.json`
`security-scheme delete`	Xóa một security scheme.	`apidog security-scheme delete <schemeId> --project <projectId>`

Đường dẫn API là đường dẫn tài nguyên API, không phải đường dẫn tệp cục bộ. Nếu shell của bạn ghi lại các giá trị bắt đầu bằng /, hãy đặt đường dẫn trong dấu nháy, ví dụ --path '/api/users', hoặc sử dụng --file để cung cấp dữ liệu endpoint.

Đối với API test case hoặc các bước HTTP trong test scenario, responseId nên sử dụng ID định nghĩa phản hồi endpoint từ endpoint.responses[].id, không phải ID thành phần phản hồi. Để tái sử dụng một thành phần phản hồi, trước tiên hãy liên kết thành phần đó trong định nghĩa phản hồi của endpoint.

Kiểm thử tự động

Sử dụng các lệnh này để quản lý API test case, test scenario, test suite, dữ liệu kiểm thử, báo cáo kiểm thử, runner và tác vụ đã lên lịch.

API test case

Lệnh	Mô tả	Ví dụ
`test-case list`	Liệt kê các API test case, tùy chọn lọc theo endpoint.	`apidog test-case list --project <projectId> --endpoint <endpointId>`
`test-case category`	Liệt kê các danh mục test case.	`apidog test-case category --project <projectId>`
`test-case get`	Xem chi tiết API test case.	`apidog test-case get <caseId> --project <projectId>`
`test-case create`	Tạo một API test case từ tệp JSON.	`apidog test-case create --project <projectId> --file ./case.json`
`test-case update`	Cập nhật một API test case.	`apidog test-case update <caseId> --project <projectId> --file ./case.json`
`test-case delete`	Xóa một API test case.	`apidog test-case delete <caseId> --project <projectId>`
`cli-schema get test-case-create`	Xem schema cho việc tạo test case.	`apidog cli-schema get test-case-create`
`cli-schema get test-case-update`	Xem schema cho cập nhật test case.	`apidog cli-schema get test-case-update`

Test scenario

Lệnh	Mô tả	Ví dụ
`test-scenario list`	Liệt kê test scenario trong một dự án.	`apidog test-scenario list --project <projectId>`
`test-scenario get`	Xem chi tiết test scenario.	`apidog test-scenario get <scenarioId> --project <projectId>`
`test-scenario create`	Tạo một test scenario.	`apidog test-scenario create --project <projectId> --file ./scenario.json`
`test-scenario update`	Cập nhật một test scenario.	`apidog test-scenario update <scenarioId> --project <projectId> --file ./scenario.json`
`test-scenario delete`	Xóa một test scenario.	`apidog test-scenario delete <scenarioId> --project <projectId>`
`test-scenario run`	Chạy một test scenario.	`apidog test-scenario run <scenarioId> --project <projectId> --environment <environmentId>`
`cli-schema get test-scenario-create`	Xem schema cho việc tạo test scenario.	`apidog cli-schema get test-scenario-create`
`cli-schema get test-scenario-update`	Xem schema cho cập nhật test scenario.	`apidog cli-schema get test-scenario-update`

Test suite

Lệnh	Mô tả	Ví dụ
`test-suite list`	Liệt kê test suite trong một dự án.	`apidog test-suite list --project <projectId>`
`test-suite get`	Xem chi tiết test suite.	`apidog test-suite get <testSuiteId> --project <projectId>`
`test-suite create`	Tạo một test suite.	`apidog test-suite create --project <projectId> --file ./suite.json`
`test-suite update`	Cập nhật một test suite.	`apidog test-suite update <testSuiteId> --project <projectId> --file ./suite.json`
`test-suite delete`	Xóa một test suite.	`apidog test-suite delete <testSuiteId> --project <projectId>`
`test-suite run`	Chạy một test suite.	`apidog test-suite run <testSuiteId> --project <projectId> --environment <environmentId>`

Dữ liệu kiểm thử

Lệnh	Mô tả	Ví dụ
`test-data list`	Liệt kê các bộ dữ liệu kiểm thử.	`apidog test-data list --project <projectId>`
`test-data get`	Xem chi tiết bộ dữ liệu kiểm thử.	`apidog test-data get <dataId> --project <projectId>`
`test-data create`	Tạo một bộ dữ liệu kiểm thử từ tệp JSON.	`apidog test-data create --project <projectId> --file ./test-data.json`
`test-data update`	Cập nhật một bộ dữ liệu kiểm thử.	`apidog test-data update <dataId> --project <projectId> --file ./test-data.json`
`test-data delete`	Xóa một bộ dữ liệu kiểm thử.	`apidog test-data delete <dataId> --project <projectId>`

Báo cáo kiểm thử

Lệnh	Mô tả	Ví dụ
`test-report list`	Liệt kê báo cáo kiểm thử trong một dự án.	`apidog test-report list --project <projectId>`
`test-report get`	Xem chi tiết báo cáo kiểm thử.	`apidog test-report get <reportId> --project <projectId>`
`test-report download`	Tải báo cáo kiểm thử xuống tệp cục bộ.	`apidog test-report download <reportId> --project <projectId> --format json --output ./report.json`
`test-report delete`	Xóa một báo cáo kiểm thử.	`apidog test-report delete <reportId> --project <projectId>`

Runner

Lệnh	Mô tả	Ví dụ
`runner list`	Liệt kê runner trong một dự án hoặc nhóm.	`apidog runner list --project <projectId>`
`runner get`	Xem chi tiết runner.	`apidog runner get <runnerId> --project <projectId>`
`runner create`	Tạo một runner nhóm.	`apidog runner create --team <teamId> --name <name> --runner-type <runnerType> --server-type <serverType>`
`runner check`	Kiểm tra tình trạng runner.	`apidog runner check <runnerId> --team <teamId>`
`runner delete`	Xóa một runner.	`apidog runner delete <runnerId> --project <projectId>`

Tác vụ đã lên lịch

Lệnh	Mô tả	Ví dụ
`scheduled-task list`	Liệt kê tác vụ đã lên lịch trong một dự án.	`apidog scheduled-task list --project <projectId>`
`scheduled-task get`	Xem chi tiết tác vụ đã lên lịch.	`apidog scheduled-task get <taskId> --project <projectId>`
`scheduled-task create`	Tạo một tác vụ đã lên lịch từ tệp JSON.	`apidog scheduled-task create --project <projectId> --file ./scheduled-task.json`
`scheduled-task update`	Cập nhật một tác vụ đã lên lịch.	`apidog scheduled-task update <taskId> --project <projectId> --file ./scheduled-task.json`
`scheduled-task delete`	Xóa một tác vụ đã lên lịch.	`apidog scheduled-task delete <taskId> --project <projectId>`
`scheduled-task run`	Kích hoạt một tác vụ đã lên lịch theo cách thủ công.	`apidog scheduled-task run <taskId> --project <projectId>`

Lệnh chạy cốt lõi: `apidog run`

Đây là lệnh chính để chạy test scenario, thư mục test scenario, test suite hoặc tệp đã xuất cục bộ. Bạn có thể sao chép các lệnh được tạo từ bảng CI/CD của client Apidog và chạy chúng trong terminal hoặc quy trình CI/CD của mình.

Thực thi trực tuyến

Khi chạy kiểm thử thời gian thực thông qua máy chủ Apidog, hãy sử dụng lệnh sau.

Sử dụng access token Apidog cùng với ID của một test scenario, thư mục test scenario hoặc test suite cụ thể. Ví dụ:

Thực thi cục bộ

Khi chạy kiểm thử ngoại tuyến bằng các tệp đã xuất, hãy sử dụng lệnh sau.

Chỉ định URL hoặc đường dẫn tệp của test scenario Apidog. Ví dụ:

Tùy chọn chạy

Tùy chọn	Mô tả
`--access-token <accessToken>`	Thiết lập token xác thực cho thực thi trực tuyến
`-t, --test-scenario <testScenarioId>`	Chỉ định ID test scenario cần chạy
`-f, --test-scenario-folder <folderId>`	Chỉ định ID thư mục test scenario cần chạy
`--test-suite <testSuiteId>`	Chỉ định ID test suite cần chạy
`--project <projectId>`	Chỉ định ID dự án
`--branch <branchName>`	Chỉ định tên nhánh; nếu bỏ qua, máy chủ mặc định dùng nhánh chính
`-r, --reporters [reporters]`	Chỉ định loại báo cáo kiểm thử (mặc định: `["cli"]`)
`--out-dir <outDir>`	Thư mục đầu ra cho báo cáo kiểm thử (mặc định: `./apidog-reports`)
`--out-file <outFile>`	Tên tệp báo cáo kiểm thử, không cần thêm phần mở rộng tệp. Bạn có thể sử dụng `{FOLDER_NAME}`, `{SCENARIO_NAME}` và `{GENERATE_TIME}`
`--out-json-failures-separated <outJsonFailuresSeparated>`	Xuất lỗi thành tệp JSON riêng biệt
`-e, --environment <environmentId>`	Chỉ định môi trường runtime
`-n, --iteration-count <n>`	Thiết lập số lần lặp
`-d, --iteration-data <path>`	Thiết lập dữ liệu cho các lần lặp case (JSON hoặc CSV)
`--on-error <behavior>`	Thiết lập hành vi xử lý lỗi (`ignore`, `continue` hoặc `end`)
`--variables <path>`	Tải biến môi trường hoặc biến toàn cục từ tệp cục bộ
`--global-var <value>`	Thiết lập biến toàn cục (định dạng `key=value`)
`--env-var <value>`	Thiết lập biến môi trường (định dạng `key=value`)
`--notification <ids>`	Gửi thông báo sau khi quá trình chạy kết thúc
`--notification-failed-event <ids>`	Chỉ gửi thông báo khi quá trình chạy thất bại
`--external-program-path <path>`	Chỉ định đường dẫn tệp cho chương trình bên ngoài
`--database-connection <path>`	Chỉ định đường dẫn tệp cho cấu hình cơ sở dữ liệu
`--ignore-redirects`	Ngăn chuyển hướng tự động
`--silent`	Ngăn đầu ra console
`--color <value>`	Bật hoặc tắt đầu ra console có màu
`--delay-request [n]`	Chỉ định độ trễ giữa các yêu cầu (ms)
`--timeout-request [n]`	Chỉ định thời gian chờ yêu cầu (ms)
`--timeout-script [n]`	Chỉ định thời gian chờ thực thi script (ms)
`-k, --insecure`	Tắt xác minh SSL
`--ssl-client-cert-list <path>`	Chỉ định đường dẫn cấu hình chứng chỉ client
`--ssl-client-cert <path>`	Chỉ định đường dẫn chứng chỉ client (PEM)
`--ssl-client-key <path>`	Chỉ định đường dẫn khóa riêng của chứng chỉ client
`--ssl-client-passphrase <passphrase>`	Chỉ định passphrase của chứng chỉ client
`--ssl-extra-ca-certs <path>`	Chỉ định chứng chỉ CA tin cậy bổ sung
`-b, --bigint`	Bật khả năng tương thích bigint
`--upload-report [value]`	Tải tổng quan báo cáo kiểm thử lên cloud
`--preferred-http-version <preferredHttpVersion>`	Thiết lập phiên bản giao thức HTTP ưu tiên
`--verbose`	Hiển thị thông tin yêu cầu và phản hồi chi tiết
`--lang <language>`	Thiết lập ngôn ngữ CLI (en)
`-h, --help`	Hiển thị thông tin trợ giúp

Khi tạo hoặc cập nhật các tài nguyên kiểm thử phức tạp như test scenario, test suite, test case, dữ liệu kiểm thử hoặc tác vụ đã lên lịch, trước tiên hãy sử dụng cli-schema get <schemaKey>, sau đó xác thực tệp cục bộ của bạn bằng cli-schema validate <schemaKey> --file <path>.

Nhập và xuất

Sử dụng các lệnh nhập và xuất để đưa tài liệu API bên ngoài vào Apidog hoặc xuất dữ liệu dự án sang các định dạng được công cụ khác sử dụng.

Nhập dữ liệu dự án

Lệnh import nhập một tệp cục bộ vào một dự án. Các định dạng được hỗ trợ bao gồm openapi, postman, har, insomnia, jmeter, wsdl, yapi, rap2, apidoc, hoppscotch, markdown, jsonschema và apidog.

Lệnh	Mô tả	Ví dụ
`import`	Nhập một tệp cục bộ vào dự án theo định dạng.	`apidog import --project <projectId> --format openapi --file ./openapi.json`

Cài đặt tự động nhập

Sử dụng import auto-import để duy trì cài đặt tự động nhập cho đồng bộ hóa dài hạn từ nguồn bên ngoài.

Lệnh	Mô tả	Ví dụ
`import auto-import list`	Liệt kê cài đặt tự động nhập trong một dự án.	`apidog import auto-import list --project <projectId>`
`import auto-import create`	Tạo một cài đặt tự động nhập.	`apidog import auto-import create --project <projectId> --file ./auto-import.json`
`import auto-import get`	Xem một cài đặt tự động nhập.	`apidog import auto-import get <settingId> --project <projectId>`
`import auto-import delete`	Xóa một cài đặt tự động nhập.	`apidog import auto-import delete <settingId> --project <projectId>`
`cli-schema get import-auto-import-create`	Xem schema cho cài đặt tự động nhập.	`apidog cli-schema get import-auto-import-create`

Xuất dữ liệu dự án

Lệnh export xuất dữ liệu dự án ra một tệp cục bộ. Các định dạng được hỗ trợ bao gồm openapi, markdown, html, postman và apidog.

Đối với xuất apidog gốc, phạm vi hỗ trợ all, apis và tags. Phạm vi thư mục chỉ khả dụng cho xuất OpenAPI.

Lệnh	Mô tả	Ví dụ
`export`	Xuất dữ liệu dự án theo định dạng.	`apidog export --project <projectId> --format openapi --output ./openapi.json`
`export --format apidog`	Xuất dữ liệu dự án gốc.	`apidog export --project <projectId> --format apidog --output ./project.apidog.json`
`export --scope apis`	Xuất các API đã chọn ở định dạng gốc.	`apidog export --project <projectId> --format apidog --scope apis --api-ids 1001,1002 --output ./selected.apidog.json`
`export --scope tags`	Xuất API theo tag ở định dạng gốc.	`apidog export --project <projectId> --format apidog --scope tags --include-tags pet,store --output ./tagged.apidog.json`
`export --format openapi --scope folders`	Xuất các thư mục đã chọn ở định dạng OpenAPI.	`apidog export --project <projectId> --format openapi --scope folders --folder-ids 2001 --output ./openapi.json`

Cài đặt xuất OAS

Sử dụng export settings để duy trì cài đặt xuất OAS có thể tái sử dụng.

Lệnh	Mô tả	Ví dụ
`export settings list`	Liệt kê cài đặt xuất OAS.	`apidog export settings list --project <projectId>`
`export settings create`	Tạo một cài đặt xuất OAS.	`apidog export settings create --project <projectId> --file ./export-setting.json`
`export settings get`	Xem một cài đặt xuất OAS.	`apidog export settings get <settingId> --project <projectId>`
`export settings update`	Cập nhật một cài đặt xuất OAS.	`apidog export settings update <settingId> --project <projectId> --file ./export-setting.json`
`export settings delete`	Xóa một cài đặt xuất OAS.	`apidog export settings delete <settingId> --project <projectId>`
`cli-schema get export-settings-create`	Xem schema cho việc tạo cài đặt xuất OAS.	`apidog cli-schema get export-settings-create`
`cli-schema get export-settings-update`	Xem schema cho cập nhật cài đặt xuất OAS.	`apidog cli-schema get export-settings-update`

Chia sẻ tài liệu

Sử dụng các lệnh này để xuất bản và chia sẻ tài liệu API.

Trang tài liệu

Lệnh	Mô tả	Ví dụ
`docs-site list`	Liệt kê các trang tài liệu.	`apidog docs-site list --project <projectId>`
`docs-site get`	Xem chi tiết trang tài liệu.	`apidog docs-site get <siteId> --project <projectId>`
`docs-site create`	Tạo một trang tài liệu.	`apidog docs-site create --project <projectId> --file ./docs-site.json`
`docs-site update`	Cập nhật cài đặt trang tài liệu.	`apidog docs-site update <siteId> --project <projectId> --file ./docs-site.json`
`docs-site delete`	Xóa một trang tài liệu.	`apidog docs-site delete <siteId> --project <projectId>`

Tài liệu được chia sẻ

Lệnh	Mô tả	Ví dụ
`shared-doc list`	Liệt kê tài liệu được chia sẻ.	`apidog shared-doc list --project <projectId>`
`shared-doc get`	Xem chi tiết tài liệu được chia sẻ.	`apidog shared-doc get <docId> --project <projectId>`
`shared-doc create`	Tạo một tài liệu được chia sẻ.	`apidog shared-doc create --project <projectId> --file ./shared-doc.json`
`shared-doc update`	Cập nhật cài đặt tài liệu được chia sẻ.	`apidog shared-doc update <docId> --project <projectId> --file ./shared-doc.json`
`shared-doc delete`	Xóa một tài liệu được chia sẻ.	`apidog shared-doc delete <docId> --project <projectId>`

Quản lý nhánh

Sử dụng các lệnh nhánh để cô lập thay đổi, cộng tác trên tài nguyên dự án và hợp nhất tài nguyên đã chọn giữa các nhánh.

Nhánh lặp

Lệnh	Mô tả	Ví dụ
`branch list --type all`	Liệt kê tất cả các loại nhánh trong một dự án.	`apidog branch list --project <projectId> --type all`
`branch list --type sprint`	Liệt kê các nhánh lặp.	`apidog branch list --project <projectId> --type sprint`
`branch get --type sprint`	Xem một nhánh lặp.	`apidog branch get <branchName> --project <projectId> --type sprint`
`branch create --type sprint`	Tạo một nhánh lặp.	`apidog branch create --project <projectId> --type sprint --name <branchName> --from main`
`branch update --type sprint`	Cập nhật một nhánh lặp.	`apidog branch update <branchName> --project <projectId> --type sprint --name <newName>`
`branch merge`	Hợp nhất các tài nguyên được chọn rõ ràng từ nhánh này sang nhánh khác.	`apidog branch merge --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>`
`branch pick-to`	Chọn các tài nguyên đã chọn từ nhánh nguồn sang nhánh đích.	`apidog branch pick-to --project <projectId> --from <sourceBranchName> --to <targetBranchName> --endpoint-ids <ids>`
`branch archive --type sprint`	Lưu trữ một nhánh lặp trước khi xóa.	`apidog branch archive <branchName> --project <projectId> --type sprint`
`branch delete --type sprint`	Xóa một nhánh lặp đã lưu trữ.	`apidog branch delete <branchName> --project <projectId> --type sprint`

Nhánh AI

Lệnh	Mô tả	Ví dụ
`branch list --type ai`	Liệt kê các nhánh AI.	`apidog branch list --project <projectId> --type ai`
`branch get --type ai`	Xem một nhánh AI.	`apidog branch get <branchName> --project <projectId> --type ai`
`branch create --type ai`	Tạo một nhánh AI từ nhánh nguồn.	`apidog branch create --project <projectId> --type ai --name <aiBranchName> --from <sourceBranchName>`
`branch update --type ai`	Cập nhật một nhánh AI.	`apidog branch update <branchName> --project <projectId> --type ai --name <newName>`
`branch archive --type ai`	Lưu trữ một nhánh AI trước khi xóa.	`apidog branch archive <branchName> --project <projectId> --type ai`
`branch delete --type ai`	Xóa một nhánh AI đã lưu trữ.	`apidog branch delete <branchName> --project <projectId> --type ai`

Nhánh chung

Lệnh	Mô tả	Ví dụ
`branch list --type general`	Liệt kê các nhánh chung.	`apidog branch list --project <projectId> --type general`
`branch get --type general`	Xem một nhánh chung.	`apidog branch get <branchName> --project <projectId> --type general`
`branch create --type general`	Tạo một nhánh chung.	`apidog branch create --project <projectId> --type general --name <branchName> --from main`
`branch update --type general`	Cập nhật một nhánh chung.	`apidog branch update <branchName> --project <projectId> --type general --name <newName>`
`branch delete --type general`	Xóa một nhánh chung.	`apidog branch delete <branchName> --project <projectId> --type general`

Các lệnh tạo nhánh chủ yếu sử dụng tùy chọn dòng lệnh như --type, --name và --from. cli-schema get branch-*-create được sử dụng để kiểm tra cấu trúc tùy chọn tạo. Đối với các tùy chọn lệnh thực tế, hãy chạy apidog branch create -h.

Merge request

Sử dụng merge-request khi nhánh đích yêu cầu quy trình review. Merge request và hợp nhất trực tiếp chỉ hợp nhất các tài nguyên được chọn rõ ràng.

Lệnh	Mô tả	Ví dụ
`merge-request preview`	Quét các thay đổi ứng viên trước khi tạo merge request hoặc hợp nhất trực tiếp.	`apidog merge-request preview --project <projectId> --from <sourceBranchName> --to <targetBranchName>`
`merge-request list`	Liệt kê merge request.	`apidog merge-request list --project <projectId> --to <targetBranchName>`
`merge-request get`	Xem chi tiết merge request.	`apidog merge-request get <mergeRequestId> --project <projectId> --to <targetBranchName>`
`merge-request create`	Tạo một merge request.	`apidog merge-request create --project <projectId> --to <targetBranchName> --from <sourceBranchName> --reviewer-ids <userIds> --endpoint-ids <ids>`
`merge-request update`	Cập nhật một merge request.	`apidog merge-request update <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./merge-request.json`
`merge-request approve`	Phê duyệt một merge request.	`apidog merge-request approve <mergeRequestId> --project <projectId> --to <targetBranchName> --file ./approve.json`
`merge-request reject`	Từ chối một merge request.	`apidog merge-request reject <mergeRequestId> --project <projectId> --to <targetBranchName>`
`merge-request delete`	Xóa một merge request.	`apidog merge-request delete <mergeRequestId> --project <projectId> --to <targetBranchName>`

Để giữ an toàn cho tài nguyên dự án, quyền ghi của CLI có thể bị hạn chế theo mặc định. Bạn có thể chỉnh sửa dữ liệu nhánh nguồn thông qua nhánh AI, hoặc bật quyền chỉnh sửa bên ngoài trong cài đặt tính năng dự án khi cần chỉnh sửa trực tiếp đối với nhánh chính, nhánh lặp tiêu chuẩn hoặc nhánh chung. Các thay đổi được thực hiện trên nhánh AI vẫn cần người dùng xác nhận trước khi merge hoặc merge-request.

Tên nhánh AI được khuyến nghị bao gồm ngày, nhánh nguồn và mục đích, ví dụ ai/20260312-from-main-user-register.

Đối với thao tác hợp nhất nhánh và chọn tài nguyên, các tùy chọn ID tài nguyên sử dụng tên số nhiều và ID số được phân tách bằng dấu phẩy, chẳng hạn như --endpoint-ids 1,2, --doc-ids 3,4 và --test-suite-ids 5,6.

Tài nguyên khác

Sử dụng các lệnh này để quản lý tài nguyên mở rộng dự án và kết nối bên ngoài.

Trường tùy chỉnh

Lệnh	Mô tả	Ví dụ
`custom-field list`	Liệt kê các trường tùy chỉnh.	`apidog custom-field list --project <projectId>`
`custom-field create`	Tạo một trường tùy chỉnh.	`apidog custom-field create --project <projectId> --file ./custom-field.json`
`custom-field update`	Cập nhật một trường tùy chỉnh.	`apidog custom-field update <customFieldId> --project <projectId> --file ./custom-field.json`
`custom-field delete`	Xóa một trường tùy chỉnh.	`apidog custom-field delete <customFieldId> --project <projectId>`

API WebSocket

Lệnh	Mô tả	Ví dụ
`websocket list`	Liệt kê API WebSocket.	`apidog websocket list --project <projectId>`
`websocket get`	Xem chi tiết API WebSocket.	`apidog websocket get <websocketId> --project <projectId>`
`websocket create`	Tạo một API WebSocket.	`apidog websocket create --project <projectId> --name <name> --url <url>`
`websocket update`	Cập nhật một API WebSocket.	`apidog websocket update <websocketId> --project <projectId> --file ./websocket.json`
`websocket delete`	Xóa một API WebSocket.	`apidog websocket delete <websocketId> --project <projectId>`

API Socket.IO

Lệnh	Mô tả	Ví dụ
`socketio list`	Liệt kê API Socket.IO.	`apidog socketio list --project <projectId>`
`socketio get`	Xem chi tiết API Socket.IO.	`apidog socketio get <socketioId> --project <projectId>`
`socketio create`	Tạo một API Socket.IO.	`apidog socketio create --project <projectId> --file ./socketio.json`
`socketio update`	Cập nhật một API Socket.IO.	`apidog socketio update <socketioId> --project <projectId> --file ./socketio.json`
`socketio delete`	Xóa một API Socket.IO.	`apidog socketio delete <socketioId> --project <projectId>`

Script chung

Lệnh	Mô tả	Ví dụ
`common-script list`	Liệt kê script chung.	`apidog common-script list --project <projectId>`
`common-script get`	Xem chi tiết script chung.	`apidog common-script get <scriptId> --project <projectId>`
`common-script create`	Tạo một script chung.	`apidog common-script create --project <projectId> --file ./common-script.json`
`common-script update`	Cập nhật một script chung.	`apidog common-script update <scriptId> --project <projectId> --file ./common-script.json`
`common-script delete`	Xóa một script chung.	`apidog common-script delete <scriptId> --project <projectId>`

Kết nối cơ sở dữ liệu

Lệnh	Mô tả	Ví dụ
`database-connection list`	Liệt kê kết nối cơ sở dữ liệu.	`apidog database-connection list --project <projectId>`
`database-connection get`	Xem chi tiết kết nối cơ sở dữ liệu.	`apidog database-connection get <connectionId> --project <projectId>`
`database-connection create`	Tạo một kết nối cơ sở dữ liệu.	`apidog database-connection create --project <projectId> --file ./database-connection.json`
`database-connection update`	Cập nhật một kết nối cơ sở dữ liệu.	`apidog database-connection update <connectionId> --project <projectId> --file ./database-connection.json`
`database-connection delete`	Xóa một kết nối cơ sở dữ liệu.	`apidog database-connection delete <connectionId> --project <projectId>`

Vault provider

Lệnh	Mô tả	Ví dụ
`vault list`	Liệt kê vault provider.	`apidog vault list --project <projectId>`
`vault get`	Xem chi tiết vault provider.	`apidog vault get <vaultProviderId> --project <projectId>`
`vault create`	Tạo một vault provider.	`apidog vault create --project <projectId> --file ./vault.json`
`vault update`	Cập nhật một vault provider.	`apidog vault update <vaultProviderId> --project <projectId> --file ./vault.json`
`vault delete`	Xóa một vault provider.	`apidog vault delete <vaultProviderId> --project <projectId>`

Kết nối Git

Lệnh	Mô tả	Ví dụ
`git-connection list`	Liệt kê kết nối Git.	`apidog git-connection list --project <projectId>`
`git-connection get`	Xem chi tiết kết nối Git.	`apidog git-connection get <connectionId> --project <projectId>`
`git-connection create`	Tạo một kết nối Git.	`apidog git-connection create --project <projectId> --file ./git-connection.json`
`git-connection update`	Cập nhật một kết nối Git.	`apidog git-connection update <connectionId> --project <projectId> --file ./git-connection.json`
`git-connection delete`	Xóa một kết nối Git.	`apidog git-connection delete <connectionId> --project <projectId>`

Quản lý và cài đặt

Sử dụng các lệnh này để quản trị dự án, thông báo, tài nguyên thùng rác, lịch sử thay đổi và nhật ký kiểm toán.

Thông báo

Lệnh	Mô tả	Ví dụ
`notification list`	Liệt kê cấu hình thông báo.	`apidog notification list --project <projectId>`
`notification get`	Xem chi tiết thông báo.	`apidog notification get <notificationId> --project <projectId>`
`notification create`	Tạo một cấu hình thông báo.	`apidog notification create --project <projectId> --file ./notification.json`
`notification update`	Cập nhật một cấu hình thông báo.	`apidog notification update <notificationId> --project <projectId> --file ./notification.json`
`notification delete`	Xóa một cấu hình thông báo.	`apidog notification delete <notificationId> --project <projectId>`

Thùng rác

Lệnh	Mô tả	Ví dụ
`recycle list`	Liệt kê tài nguyên trong thùng rác.	`apidog recycle list --project <projectId>`
`recycle restore`	Khôi phục tài nguyên từ thùng rác.	`apidog recycle restore <itemId> --project <projectId>`
`recycle delete`	Xóa vĩnh viễn tài nguyên trong thùng rác.	`apidog recycle delete <itemId> --project <projectId>`

Lịch sử

Lệnh	Mô tả	Ví dụ
`history list`	Liệt kê lịch sử thay đổi dự án.	`apidog history list --project <projectId>`
`history get`	Xem chi tiết lịch sử thay đổi.	`apidog history get <historyId> --project <projectId>`

Nhật ký kiểm toán

Lệnh	Mô tả	Ví dụ
`audit-log list`	Liệt kê nhật ký kiểm toán dự án.	`apidog audit-log list --project <projectId>`
`audit-log get`	Xem chi tiết nhật ký kiểm toán.	`apidog audit-log get <auditLogId> --project <projectId>`

Sử dụng nâng cao

Tải tệp lên trong CLI

Khi làm việc với các API yêu cầu tải tệp lên, việc thiết lập chính xác đường dẫn của tệp cần tải lên là rất quan trọng. Bạn nên lưu tệp trên cùng máy nơi các kiểm thử chạy và tham chiếu tệp bằng đường dẫn tuyệt đối hoặc tương đối. Làm theo các bước sau để tham chiếu một tệp cần tải lên.

Sao chép trước tệp cần thiết vào máy đang chạy CLI. Ví dụ, nếu bạn đang sử dụng GitHub Actions làm pipeline CI/CD, hãy sao chép tệp cần thiết vào cùng GitHub repository với workflow của bạn.

Trong Apidog, điều hướng đến test scenario của bạn và tìm bước yêu cầu tải tệp lên. Nhấp vào nút Bulk Edit như hiển thị bên dưới.

Nút chỉnh sửa hàng loạt trong chi tiết bước test scenario

Sao chép đường dẫn của tệp bạn đã sao chép vào máy CLI. Sau đó thay thế giá trị tham số trường tệp bằng đường dẫn tệp trên máy CLI. Ví dụ, nếu bạn đặt một tệp png trong thư mục data trong GitHub repo, bạn có thể sử dụng data/to-be-uploaded.png để tham chiếu tệp đó.

Cấu hình đường dẫn tệp trong chế độ chỉnh sửa hàng loạt

Sau cấu hình này, tệp có thể được gửi chính xác đến Apidog thông qua CLI.

Nếu bạn muốn chạy lại test scenario này cục bộ, bạn sẽ cần sửa đường dẫn tệp trong giá trị tham số trở lại đường dẫn trên máy cục bộ của mình.

Sử dụng thao tác cơ sở dữ liệu trong CLI

Khi test scenario của bạn bao gồm thao tác cơ sở dữ liệu, bạn cần thực hiện thêm một vài bước vì cấu hình cơ sở dữ liệu được lưu cục bộ, không phải trên cloud. Điều này có nghĩa là bạn không thể trực tiếp chạy CLI ở chế độ cloud cho các scenario này. Sau đây là cách xử lý tình huống này:

Đối với các test scenario bao gồm thao tác cơ sở dữ liệu, bạn sẽ thấy một lời nhắc trong giao diện tạo dòng lệnh: "Download the database configuration file."

Tải tệp này xuống và đặt tệp vào thư mục nơi bạn dự định chạy Apidog CLI.

Dòng lệnh được tạo tự động sẽ bao gồm tùy chọn --database-connection. Bạn có thể sử dụng nguyên dòng lệnh này để chạy kiểm thử.

Tải báo cáo kiểm thử CLI cục bộ lên cloud

Để tải báo cáo kiểm thử CLI cục bộ của bạn lên cloud, bạn có thể thêm tham số --upload-report vào cuối lệnh CLI. Sau đây là cách thực hiện:

Thêm tham số --upload-report vào lệnh CLI của bạn:

Lệnh này sẽ chạy kiểm thử của bạn và tự động tải báo cáo kiểm thử lên cloud sau khi hoàn tất.

Để xem báo cáo đã tải lên:

Đi tới phần "Test Reports" trong bảng điều khiển Apidog của bạn.

Tìm cột "Team Reports".

Lưu ý: Đối với báo cáo được tải lên qua CLI, trường "Tester" sẽ được hiển thị trống.

Sử dụng script/chương trình bên ngoài trong CLI

Bạn có thể tham chiếu script hoặc chương trình bên ngoài khi chạy Apidog CLI bằng cách thêm đường dẫn của chúng vào cuối lệnh. Sau đây là cách thực hiện:

Trong ví dụ này, CLI được chỉ thị tham chiếu các chương trình nằm trong thư mục ./scripts. Nếu không chỉ định phân cấp, mặc định là thư mục thực thi CLI hiện tại.

Có hai cách tiếp cận chính để quản lý các script bên ngoài này:

1. Đường dẫn cục bộ

Để tránh nhầm lẫn khi quản lý script cục bộ, bạn nên:

Tổ chức tất cả tệp script theo danh mục

Đặt chúng trong một thư mục cụ thể

Chỉ định đường dẫn cục bộ tương ứng trong lệnh CLI

2. Repository mã nguồn trên cloud

Ngoài ra, bạn có thể:

Lưu trữ tệp script trong repository mã nguồn trên cloud

Thiết lập các lệnh pull trong workflow CI/CD của bạn để lấy script bên ngoài về môi trường cục bộ

Chỉ định đường dẫn thực tế của script bên ngoài trong lệnh CLI

SSL

Chứng chỉ client

Apidog CLI hỗ trợ truyền vào chứng chỉ client.

Sử dụng một chứng chỉ SSL client duy nhất

--ssl-client-cert
Chỉ định đường dẫn của chứng chỉ SSL client công khai.

--ssl-client-key
Chỉ định đường dẫn của chứng chỉ SSL client riêng tư (tùy chọn).

--ssl-client-passphrase
Chỉ định passphrase SSL client (tùy chọn).

Sử dụng tệp cấu hình chứng chỉ SSL client (hỗ trợ nhiều chứng chỉ)

--ssl-client-cert-list
Chỉ định đường dẫn của tệp JSON chứa danh sách chứng chỉ SSL client. Ví dụ: ssl-client-cert-list.json

[
    {
        "name": "domain1",
        "matches": ["https://test.domain1.com/*", "https://www.domain1/*"],
        "key": {"src": "/CI/client.domain1.key"},
        "cert": {"src": "/CI/client.domain1.crt"},
        "passphrase": "changeme"
    },
    {
        "name": "domain2",
        "matches": ["https://domain2.com/*"],
        "key": {"src": "/CI/client.domain2.key"},
        "cert": {"src": "/CI/client.domain2.crt"},
        "passphrase": "changeme"
    }
]

Tùy chọn này hỗ trợ thiết lập các chứng chỉ SSL client khác nhau dựa trên URL hoặc hostname. Tùy chọn này được ưu tiên hơn các tùy chọn --ssl-client-cert, --ssl-client-key và --ssl-client-passphrase. Các tùy chọn đó sẽ được sử dụng làm tùy chọn dự phòng nếu không có URL nào trong danh sách khớp.

HTTP/2

CLI có thể được cấu hình để sử dụng các phiên bản giao thức cụ thể khi gửi yêu cầu bằng tham số --preferred-http-version.

Giá trị tham số phiên bản giao thức:

"HTTP/2" - HTTP/2 Application-Layer Protocol Negotiation (ALPN), chỉ được hỗ trợ cho yêu cầu HTTPS.

"HTTP/2-with-prior-knowledge" - HTTP/2 với prior knowledge.

"HTTP/1" - HTTP/1.1.

Tham số hỗ trợ các cấu hình sau:

Thiết lập các phiên bản giao thức khác nhau cho yêu cầu HTTPS và HTTP:

Thiết lập cùng một phiên bản giao thức cho cả HTTPS và HTTP:

Thiết lập HTTP/2 cho cả HTTPS và HTTP (các giá trị không được hỗ trợ sẽ tự động bị bỏ qua):

Câu hỏi thường gặp

Cách xử lý thông báo lỗi Invalid character in header content['Authorization']?

Lỗi này thường do các ký tự không hợp lệ trong header Authorization, chẳng hạn như ký tự không phải ASCII, ngắt dòng hoặc khoảng trắng thừa. Nếu bạn chắc chắn rằng việc chạy test scenario trong client Apidog hoặc giao diện web không tạo ra bất kỳ lỗi nào, vui lòng kiểm tra xem bạn đã thiết lập giá trị INITIAL cho các biến trong môi trường của mình hay chưa và xác nhận rằng giá trị Authorization khớp với định dạng dự kiến.

Làm cách nào để chỉnh sửa trực tiếp dữ liệu dự án mà không sử dụng nhánh AI?

Quyền ghi dự án có thể bị hạn chế vì lý do an toàn. Hãy kiểm tra cài đặt tính năng của dự án và bật quyền chỉnh sửa bên ngoài khi cần chỉnh sửa trực tiếp.

Tùy chọn Apidog CLI

Cú pháp Apidog CLI cơ bản#

Xác thực#

CLI Schema#

Nhóm và dự án#

Quản lý nhóm#

Quản lý dự án#

Cài đặt dự án#

Môi trường và biến#

Quản lý môi trường#

Quản lý biến#

Tài nguyên thiết kế API#

Endpoint HTTP API#

Schema dữ liệu#

Tài liệu Markdown#

Thư mục tài nguyên#

Quy tắc mock#

Tham số chung#

Thành phần phản hồi#

Security scheme#

Kiểm thử tự động#

API test case#

Test scenario#

Test suite#

Dữ liệu kiểm thử#

Báo cáo kiểm thử#

Runner#

Tác vụ đã lên lịch#

Lệnh chạy cốt lõi: apidog run#

Thực thi trực tuyến#

Thực thi cục bộ#

Tùy chọn chạy#

Nhập và xuất#

Nhập dữ liệu dự án#

Cài đặt tự động nhập#

Xuất dữ liệu dự án#

Cài đặt xuất OAS#

Chia sẻ tài liệu#

Trang tài liệu#

Tài liệu được chia sẻ#

Quản lý nhánh#

Nhánh lặp#

Nhánh AI#

Nhánh chung#

Merge request#

Tài nguyên khác#

Trường tùy chỉnh#

API WebSocket#

API Socket.IO#

Script chung#

Kết nối cơ sở dữ liệu#

Vault provider#

Kết nối Git#

Quản lý và cài đặt#

Thông báo#

Thùng rác#

Lịch sử#

Nhật ký kiểm toán#

Sử dụng nâng cao#

Tải tệp lên trong CLI#

Sử dụng thao tác cơ sở dữ liệu trong CLI#

Tải báo cáo kiểm thử CLI cục bộ lên cloud#

Sử dụng script/chương trình bên ngoài trong CLI#

1. Đường dẫn cục bộ#

2. Repository mã nguồn trên cloud#

SSL#

Chứng chỉ client#

Sử dụng một chứng chỉ SSL client duy nhất#

Sử dụng tệp cấu hình chứng chỉ SSL client (hỗ trợ nhiều chứng chỉ)#

HTTP/2#

Câu hỏi thường gặp#

Cú pháp Apidog CLI cơ bản

Xác thực

CLI Schema

Nhóm và dự án

Quản lý nhóm

Quản lý dự án

Cài đặt dự án

Môi trường và biến

Quản lý môi trường

Quản lý biến

Tài nguyên thiết kế API

Endpoint HTTP API

Schema dữ liệu

Tài liệu Markdown

Thư mục tài nguyên

Quy tắc mock

Tham số chung

Thành phần phản hồi

Security scheme

Kiểm thử tự động

API test case

Test scenario

Test suite

Dữ liệu kiểm thử

Báo cáo kiểm thử

Runner

Tác vụ đã lên lịch

Lệnh chạy cốt lõi: `apidog run`

Thực thi trực tuyến

Thực thi cục bộ

Tùy chọn chạy

Nhập và xuất

Nhập dữ liệu dự án

Cài đặt tự động nhập

Xuất dữ liệu dự án

Cài đặt xuất OAS

Chia sẻ tài liệu

Trang tài liệu

Tài liệu được chia sẻ

Quản lý nhánh

Nhánh lặp

Nhánh AI

Nhánh chung

Merge request

Tài nguyên khác

Trường tùy chỉnh

API WebSocket

API Socket.IO

Script chung

Kết nối cơ sở dữ liệu

Vault provider

Kết nối Git

Quản lý và cài đặt

Thông báo

Thùng rác

Lịch sử

Nhật ký kiểm toán

Sử dụng nâng cao

Tải tệp lên trong CLI

Sử dụng thao tác cơ sở dữ liệu trong CLI

Tải báo cáo kiểm thử CLI cục bộ lên cloud

Sử dụng script/chương trình bên ngoài trong CLI

1. Đường dẫn cục bộ

2. Repository mã nguồn trên cloud

SSL

Chứng chỉ client

Sử dụng một chứng chỉ SSL client duy nhất

Sử dụng tệp cấu hình chứng chỉ SSL client (hỗ trợ nhiều chứng chỉ)

HTTP/2

Câu hỏi thường gặp