Làm thế nào để chia sẻ API với cộng tác viên trong Apidog?
Trong phát triển, giao tiếp và cộng tác API, tài liệu API về mặt logic là tiêu chuẩn, nhưng trên thực tế vẫn tồn tại vấn đề truyền tay các tệp ở định dạng Word hoặc PDF. Vì lý do này, tài liệu trực tuyến được khuyến nghị nhằm nâng cao hiệu quả giao tiếp giữa các nhóm.
Chuyển sang module Share Docs ở phía bên trái.Nhấp vào "New" để tạo một Chia sẻ nhanh mới. Một dự án hỗ trợ nhiều Chia sẻ nhanh khác nhau, có thể được phân phối cho các cộng tác viên khác nhau. Mọi thành viên trong nhóm đều có thể xem tất cả Chia sẻ nhanh do mọi người tạo.Trong cửa sổ bật lên New Share, bạn có thể tùy chỉnh các tùy chọn sau:
Tiêu đề: Tên của chia sẻ này, chỉ hiển thị trong nhóm Apidog, được dùng để nhận diện nội bộ, không hiển thị trong tài liệu được chia sẻ.
Môi trường: Chọn các môi trường có sẵn trong tài liệu trực tuyến. Theo mặc định, không có môi trường nào được chọn. Bạn có thể chọn nhiều môi trường. Các môi trường đã chọn sẽ hiển thị cho người đọc trong tài liệu và có thể được dùng để gửi yêu cầu khi sử dụng "Try it out".
Nếu bạn chọn môi trường Cloud mock khi tạo tài liệu, điều đó tương đương với việc bật một môi trường sandbox đơn giản cho người đọc tài liệu.
Nội dung tài liệu: Tài liệu có hai thành phần tùy chọn: Base URL và Request samples. Bạn có thể chọn có hiển thị chúng trong tài liệu hay không.
Base URL: Đây là URL cơ sở được thiết lập trong môi trường. Nếu được chọn, mỗi giao diện trong tài liệu sẽ hiển thị URL đầy đủ; nếu không được chọn, URL trong tài liệu sẽ bắt đầu bằng "/".
Request samples: Có hiển thị mã ví dụ để gọi yêu cầu hay không. Xem Request Samples để biết chi tiết.
Cho phép xuất dữ liệu: Có cho phép người đọc xuất dữ liệu ở định dạng OAS/Markdown/HTML/Apidog hay không.
Phạm vi chia sẻ: Chọn các API endpoint và Markdown cần đưa vào chia sẻ này. Bạn có thể chọn theo thư mục hoặc lọc và loại trừ theo thẻ.
Bảo mật: Bạn có thể thiết lập việc có yêu cầu mật khẩu để truy cập tài liệu này hay không, cũng như thời gian hết hạn của tài liệu này. Nếu không chọn thời gian hết hạn, tài liệu sẽ không bao giờ hết hạn.
Hiển thị trường API: Bạn có thể thiết lập việc các trường này có được hiển thị trong tài liệu hay không. Bao gồm: Owners, Update time, OperationId, Original link, Authorization Required.
Ngôn ngữ: Thiết lập ngôn ngữ tại đây sẽ ảnh hưởng đến văn bản cố định mang tính chức năng trong tài liệu, chẳng hạn như "Query Params", "Request samples", v.v., nhưng sẽ không ảnh hưởng đến văn bản được viết trong nội dung tài liệu API.
Thiết lập nâng cao: Bạn có thể thiết lập Hide 'Try it out' Button và Hide 'Powered by Apidog' tại đây.
Chia sẻ nhanh hỗ trợ "chia sẻ toàn bộ thư mục". Tính năng này phù hợp với các tình huống mà sau khi chia sẻ liên kết, bạn có thể đã thêm hoặc xóa tài liệu trong thư mục và muốn cộng tác viên có thể xem đồng bộ những thay đổi này.Trong "Phạm vi chia sẻ", khi bạn chọn "Manual selection", bạn có thể thấy "share entire folder". Nếu được bật, cộng tác viên sẽ luôn thấy tất cả tài liệu trong thư mục mà bạn không cần phải chỉnh sửa thủ công phạm vi chia sẻ sau khi thêm tài liệu.
