사용자 지정 프로토콜 API

사용자 지정 프로토콜 API는 사용자 지정 프로토콜이 있는 API를 관리하는 데 사용됩니다.

이 기능을 사용하면 Thrift, UDP, Kafka, RabbitMQ, RocketMQ 등 다양한 유형의 프로토콜에 대한 API 문서를 통합된 방식으로 생성하고 유지 관리할 수 있으며, 모두 Apidog 내에서 중앙 집중식으로 관리됩니다.

HTTP API 문서와 마찬가지로, 사용자 지정 프로토콜 API 문서도 폴더 트리, 검색 및 필터 옵션, 일괄 관리, 온라인 공유를 지원하므로 팀이 더 쉽게 협업하고 외부에 공유할 수 있습니다.

사용자 지정 프로토콜 API 생성

폴더 트리 위에서 + 아이콘에 마우스를 올린 다음, New Other Protocol APIs를 선택하고 Other Custom Protocol API를 클릭하십시오.

프로토콜 유형을 선택하십시오. 옵션에는 Thrift, Kafka 등이 포함되며, Manage Protocol을 클릭하여 사용자 지정 프로토콜을 추가할 수도 있습니다.

각 프로토콜에 대해 기본 템플릿이 제공됩니다.

다음 세부 정보를 입력하십시오.

URI: 엔드포인트의 고유 ID로, 다른 엔드포인트와 구분하는 데 사용됩니다(HTTP 엔드포인트의 URL 경로와 유사함).

Endpoint Name: 엔드포인트의 이름입니다.

Basic Information: 상태, 유지 관리자, 태그 및 기타 세부 정보입니다.

Documentation Details: 설명, 사용 지침, 예시 등을 더 유연하게 편집할 수 있도록 합니다.

저장한 후에는 선택한 프로토콜에 대한 엔드포인트 문서가 생성된 것을 확인할 수 있습니다.

사용자 지정 프로토콜 API 문서도 온라인 공유를 지원하므로 협업과 외부 발표가 더 쉬워집니다.

협업 링크를 복사하여 프로젝트 내에서 공유할 수 있습니다.

또한 Publish Docs > Quick Share로 이동하여 포함할 엔드포인트를 선택하고, 사용자 지정 프로토콜 API 문서를 공유할지 여부를 선택할 수도 있습니다.