Custom Protocol API

Custom Protocol API được sử dụng để quản lý các API với giao thức tùy chỉnh.

Với tính năng này, bạn có thể tạo và duy trì tài liệu API cho nhiều loại giao thức khác nhau (chẳng hạn như Thrift, UDP, Kafka, RabbitMQ, RocketMQ, v.v.) theo một cách thống nhất, tất cả được quản lý tập trung trong Apidog.

Tương tự như tài liệu HTTP API, tài liệu custom protocol API cũng hỗ trợ cây thư mục, tùy chọn tìm kiếm và lọc, quản lý hàng loạt và chia sẻ trực tuyến — giúp các nhóm cộng tác và chia sẻ ra bên ngoài dễ dàng hơn.

Tạo Custom Protocol API

Phía trên cây thư mục, di chuột qua biểu tượng +, sau đó chọn New Other Protocol APIs và nhấp vào Other Custom Protocol API.

Chọn một loại giao thức (các tùy chọn bao gồm Thrift, Kafka, v.v., hoặc nhấp vào Manage Protocol để thêm giao thức tùy chỉnh).

Có các mẫu mặc định khả dụng cho từng giao thức.

Điền các thông tin chi tiết sau:

URI: ID duy nhất cho endpoint, được sử dụng để phân biệt endpoint này với các endpoint khác (tương tự như đường dẫn URL đối với HTTP endpoints).

Endpoint Name: Tên của endpoint.

Basic Information: Trạng thái, người duy trì, thẻ và các thông tin chi tiết khác.

Documentation Details: Cho phép chỉnh sửa mô tả, hướng dẫn sử dụng, ví dụ, v.v. một cách linh hoạt hơn.

Sau khi lưu, bạn sẽ thấy tài liệu endpoint cho giao thức đã chọn được tạo.

Chia sẻ tài liệu Custom Protocol API

Tài liệu custom protocol API cũng hỗ trợ chia sẻ trực tuyến, giúp việc cộng tác và trình bày ra bên ngoài trở nên dễ dàng hơn.

Bạn có thể sao chép liên kết cộng tác để chia sẻ trong dự án.

Bạn cũng có thể đi tới Publish Docs > Quick Share, chọn các endpoint cần bao gồm và chọn có chia sẻ tài liệu custom protocol API hay không.

Tạo Custom Protocol API#

Chia sẻ tài liệu Custom Protocol API#

Tạo Custom Protocol API

Chia sẻ tài liệu Custom Protocol API