Trường Endpoint Tùy chỉnh

Khi cộng tác về API, có thể cần một số trường bổ sung tùy chỉnh để mô tả endpoint. Ví dụ: bạn có thể thêm các trường như "Yêu cầu ủy quyền", "Định dạng phản hồi" hoặc "Chính sách giới hạn tốc độ" để cung cấp thêm ngữ cảnh cho người dùng sử dụng API.

Trong Apidog, bạn có thể tận dụng Trường tùy chỉnh để triển khai các trường bổ sung này một cách liền mạch.

Cấu hình Trường Tùy chỉnh

Bạn có thể thiết lập các trường endpoint trong Apidog bằng cách điều hướng đến Settings > General Settings > Feature Settings > Endpoint Feature Settings. Các trường tùy chỉnh mà bạn cấu hình tại đây sẽ được áp dụng trên toàn bộ dự án trong Apidog.

Apidog cung cấp ba trường tích hợp mặc định mà bạn có thể bật hoặc tắt thủ công. Nếu được bật, trường đó sẽ xuất hiện trong siêu dữ liệu endpoint.

Thêm Trường Mới

Bạn cũng có sự linh hoạt để thêm các trường tùy chỉnh của mình khi cần.

Các loại trường được hỗ trợ:

Văn bản

Số

Chọn một

Chọn nhiều

Ngày

Thành viên nhóm

Liên kết

Nhãn đơn

Nhãn nhiều

Hiển thị Trường trong Tài liệu API

Trong Quick Share, bạn có tùy chọn chọn có hiển thị các trường tùy chỉnh này hay không.

Khi tạo Quick Share trong Apidog, bạn có thể chọn tùy chọn "Show API Fields" để bao gồm các trường API mà bạn đã định nghĩa.

Chọn các trường sẽ được hiển thị.

Chúng sẽ được hiển thị trong tài liệu.

Khi xuất bản tài liệu trong Apidog, bạn cũng có thể chọn các trường sẽ hiển thị. Trong phần Publish Docs, bên dưới Publish Docs Sites > Customize > Appearance & Display Content, bạn có tùy chọn chọn các trường.

Trường Endpoint Tùy chỉnh

Cấu hình Trường Tùy chỉnh#

Thêm Trường Mới#

Hiển thị Trường trong Tài liệu API#

Cấu hình Trường Tùy chỉnh

Thêm Trường Mới

Hiển thị Trường trong Tài liệu API