La API de protocolo personalizado se utiliza para gestionar APIs con protocolos personalizados.Con esta función, puede crear y mantener documentación de API para distintos tipos de protocolos (como Thrift, UDP, Kafka, RabbitMQ, RocketMQ, etc.) de forma unificada, todo gestionado centralmente dentro de Apidog.Al igual que la documentación de API HTTP, la documentación de API de protocolo personalizado también admite un árbol de carpetas, opciones de búsqueda y filtrado, gestión masiva y uso compartido en línea, lo que facilita la colaboración de los equipos y el uso compartido externo.
Encima del árbol de carpetas, coloque el cursor sobre el icono +, seleccione New Other Protocol APIs y haga clic en Other Custom Protocol API.
2
Seleccione un tipo de protocolo (las opciones incluyen Thrift, Kafka, etc., o haga clic en Manage Protocol para añadir un protocolo personalizado).
Hay plantillas predeterminadas disponibles para cada protocolo.
3
Complete los siguientes detalles:
URI: El ID único del endpoint, utilizado para distinguirlo de otros (similar a una ruta URL para endpoints HTTP).
Endpoint Name: El nombre del endpoint.
Basic Information: Estado, responsables de mantenimiento, etiquetas y otros detalles.
Documentation Details: Permite editar descripciones, instrucciones de uso, ejemplos y más de forma flexible.
4
Después de guardar, verá creada la documentación del endpoint para el protocolo seleccionado.
Compartir documentación de API de protocolo personalizado#
La documentación de API de protocolo personalizado también admite el uso compartido en línea, lo que facilita la colaboración y la presentación externa.Puede copiar un enlace de colaboración para compartirlo dentro del proyecto.
También puede ir a Publish Docs > Quick Share, seleccionar qué endpoints incluir y elegir si desea compartir la documentación de API de protocolo personalizado.