Cộng tác nhóm

Cộng tác nhiều người dùng & đồng bộ thời gian thực

Khả năng cộng tác thời gian thực của tài liệu API giúp cải thiện hiệu quả làm việc cho các nhóm R&D và giảm chi phí giao tiếp lặp lại. Các mô-đun HTTP API và mô hình dữ liệu trong quản lý API hỗ trợ cộng tác trực tuyến theo thời gian thực cho nhiều người dùng. Khi người khác lưu dữ liệu, trang hiện tại sẽ tự động cập nhật các thay đổi do các thành viên khác trong nhóm thực hiện.

Kịch bản áp dụng

Trong các kịch bản sau, tài liệu API mới sẽ được tự động đồng bộ với các thành viên trong nhóm mà không cần làm mới toàn cục thủ công:

Sửa đổi và lưu một API trong App

Sau khi định kỳ nhập các tệp Swagger/OpenAPI

Điểm nổi bật

Các tính năng cộng tác nhiều người dùng của Apidog bao gồm:

Hiển thị avatar của người chỉnh sửa theo thời gian thực, cho thấy rõ ai đang chỉnh sửa cùng một API

Cộng tác ở cấp trường, giúp tránh xung đột nội dung một cách hiệu quả

Nếu có xung đột, bạn sẽ biết trong khi chỉnh sửa để có thể giải quyết trước và tiếp tục chỉnh sửa

Giải quyết xung đột chi tiết, cho phép giữ lại một phần nội dung từ cả hai phía

Tài liệu API có lịch sử phiên bản và thùng rác, hỗ trợ khôi phục về các phiên bản cũ, không cần lo lắng về các sửa đổi ngoài ý muốn

Nhập tự động và plugin IDEA cũng là một phần của cộng tác thời gian thực; dữ liệu được tự động cập nhật sau khi nhập

Liên kết cộng tác

Tính năng "Liên kết cộng tác" cho phép các thành viên trong nhóm nhanh chóng định vị API và cộng tác.

INFO

Liên kết cộng tác chỉ được dùng để chia sẻ trong nội bộ nhóm, và những người không thuộc nhóm không thể mở liên kết cộng tác.

Sao chép liên kết cộng tác

Nhấn nút Copy Collaboration Link trên thanh menu ở phía bên phải của API để tạo liên kết cộng tác. Gửi liên kết đó cho các thành viên khác trong nhóm; khi mở liên kết, bạn có thể định vị trực tiếp API tương ứng trong giao diện web.

Đặc tả URL liên kết

Liên kết Apidog bao gồm một số thành phần chính:

ID dự án

Ví dụ: https://apidog.com/web/project/{Project-ID}

Endpoint được chỉ định trong dự án

Ví dụ: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}

Tab được chỉ định trong một endpoint

Ví dụ: https://apidog.com/web/project/{Project-ID}/apis/api-{API-ID}-run

Cấu trúc URL này cho phép người dùng truy cập các dự án, API và chế độ xem cụ thể trong nền tảng Apidog.

Nhúng giá trị tham số trong URL

Khi chia sẻ endpoint Apidog, hành vi mặc định là chỉ bao gồm đặc tả API mà không có bất kỳ giá trị tham số nào. Tuy nhiên, nếu bạn cần chia sẻ tài liệu có bao gồm các giá trị tham số hoặc biến cụ thể, bạn có thể nhúng chúng trực tiếp vào URL của tài liệu.

Truyền giá trị tham số

Có hai cách để nhúng giá trị tham số vào URL: chế độ đơn giản và chế độ phức tạp. Chế độ đơn giản trực quan hơn và không yêu cầu mã hóa URL, nhưng không hỗ trợ ký tự ngoặc vuông. Chế độ phức tạp hỗ trợ tất cả ký tự nhưng yêu cầu mã hóa dữ liệu tham số.

Chế độ đơn giản

Trong chế độ đơn giản, bạn có thể dùng định dạng query[xxx]=yyy để gán giá trị yyy cho tham số có tên xxx.

Ví dụ:

https://apidog.com/web/project/406014/apis/api-10061199-run?query[aaa]=yyy&query[bbb]=yyy&path[aaa]=yyy&body[aaa]=yyy&header[aaa]=yyy&cookie[aaa]=yyy&environment[aaa]=yyy

Loại tham số	Giá trị tham số	Mô tả
Tham số query	`query[xxx]=yyy`
Tham số path	`path[xxx]=yyy`
Tham số body	`body[xxx]=yyy`	Dành cho các loại body form-data hoặc x-www-urlencoded
Tham số body	`body=yyy`	Dành cho các loại body khác
Tham số header	`header[xxx]=yyy`
Tham số cookie	`cookie[xxx]=yyy`
Biến môi trường	`environment[xxx]=yyy`	Các giá trị này sẽ được lưu vào biến môi trường mặc định

Chế độ phức tạp

Chế độ phức tạp cho phép nhúng tham số nâng cao hơn bằng cách mã hóa một đối tượng JSON. Giá trị của tham số params được lấy bằng cách gọi encodeURIComponent trên dữ liệu JSON sau:

{
    "query": [
        ["id", "value1"], 
        ["id", "value2"], 
        ["key2", "value3"]
    ],
    "path": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ],
    "body": [
        ["aaa", "value1"], 
        ["key2", "value2"]
    ],
    "header": [
        ["testHeader", "value1"], 
        ["key2", "value2"]
    ], 
    "cookie": [
        ["testCookie", "value1"], 
        ["key2", "value2"]
    ], 
    "environment": [
        ["key1", "value1"], 
        ["key2", "value2"]
    ]
}

URL đã mã hóa sẽ có dạng:

https://apidog.com/web/project/406014/apis/api-10061199-run?params={ "query"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "body"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "cookie"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" }%2C "environment"%3A{ "aaa"%3A"xxx"%2C "bbb"%3A"yyy" } }

Loại tham số	Giá trị tham số	Mô tả
Tham số query	`query`
Tham số path	`path`
Tham số body	`body`	Nếu loại body là form-data hoặc x-www-urlencoded, giá trị của body là JSON; nếu không, giá trị của body là một chuỗi
Tham số header	`header`
Tham số cookie	`cookie`
Biến môi trường	`environment`	Các giá trị này sẽ được lưu vào biến môi trường mặc định

Truyền biến môi trường

Bạn cũng có thể dùng URL để tự động thiết lập "biến môi trường" của người dùng bằng cách truyền tham số. Để thực hiện việc này, hãy thêm tham số URL theo định dạng environment[variable name]=variable value.

Ví dụ:

https://apidog.com/web/project/406014?environment[aaa]=xxx&environment[bbb]=yyy

https://apidog.com/web/project/406014/apis/api-10061199-run?environment[aaa]=xxx

Thay đổi phương thức mở

Liên kết cộng tác hỗ trợ mở cả trong ứng dụng khách và trên web. Nếu bạn muốn định vị API thông qua ứng dụng khách, hãy truy cập Apidog Web, nhấn Settings ⚙, và bật tùy chọn Always open collaboration links on desktop trong General.

INFO

Tùy chọn này chỉ khả dụng trên Apidog Web, không khả dụng trên Apidog Client.

Ứng dụng khách sẽ được tự động gọi khi truy cập liên kết cộng tác.

Cộng tác nhiều người dùng & đồng bộ thời gian thực#

Kịch bản áp dụng#

Điểm nổi bật#

Liên kết cộng tác#

Sao chép liên kết cộng tác#

Đặc tả URL liên kết#

Nhúng giá trị tham số trong URL#

Truyền giá trị tham số#

Chế độ đơn giản#

Chế độ phức tạp#

Truyền biến môi trường#

Thay đổi phương thức mở#

Cộng tác nhiều người dùng & đồng bộ thời gian thực

Kịch bản áp dụng

Điểm nổi bật

Liên kết cộng tác

Sao chép liên kết cộng tác

Đặc tả URL liên kết

Nhúng giá trị tham số trong URL

Truyền giá trị tham số

Chế độ đơn giản

Chế độ phức tạp

Truyền biến môi trường

Thay đổi phương thức mở