Campos personalizados de endpoint

Al colaborar en APIs, puede existir la necesidad de contar con algunos campos adicionales personalizados para describir endpoints. Por ejemplo, podría añadir campos como "Autorización requerida", "Formato de respuesta" o "Política de limitación de tasa" para proporcionar más contexto a los usuarios que consumen la API.

En Apidog, puede aprovechar Campos personalizados para implementar estos campos adicionales sin dificultad.

Configuración de campos personalizados

Puede configurar campos de endpoint en Apidog navegando a Settings > General Settings > Feature Settings > Endpoint Feature Settings. Los campos personalizados que configure aquí se aplicarán a todo el proyecto en Apidog.

Apidog proporciona tres campos integrados predeterminados que puede habilitar o deshabilitar manualmente. Si están habilitados, el campo aparecerá en los metadatos del endpoint.

Añadir nuevos campos

También tiene la flexibilidad de añadir sus campos personalizados según sea necesario.

Tipos de campo compatibles:

Texto

Número

Selección única

Selección múltiple

Fecha

Miembro del equipo

Enlace

Correo electrónico

Etiqueta única

Etiqueta múltiple

Mostrar campos en la documentación de la API

En Quick Share, tiene la opción de elegir si desea mostrar estos campos personalizados.

Al crear un Quick Share en Apidog, puede seleccionar la opción "Show API Fields" para incluir los campos de API que definió.

Seleccione los campos que se mostrarán.

Se mostrarán en la documentación.

Al publicar documentación en Apidog, también puede elegir qué campos mostrar. En la sección Publish Docs, en Publish Docs Sites > Customize > Appearance & Display Content, tiene la opción de seleccionar campos.

Selección de campos de publicación de documentación

Campos personalizados de endpoint

Configuración de campos personalizados#

Añadir nuevos campos#

Mostrar campos en la documentación de la API#

Configuración de campos personalizados

Añadir nuevos campos

Mostrar campos en la documentación de la API