Cada artículo final en tu glosario {{. El espacio de trabajo de documentación de la API incluye un conjunto de opciones para añadir contenido personalizado, configurar la configuración de artículos, colaborar con tu equipo y controlar el acceso. Este artículo cubre todo lo disponible en una página de artículo de endpoint.
Añadir contenido personalizado a los artículos de endpoint
Puedes añadir y formatear contenido personalizado directamente dentro de las páginas de endpoint de tu API usando el mini editor avanzado integrado. Esto es útil para añadir notas de uso, ejemplos de código o contexto que no esté capturado en tu especificación de OpenAPI.
Para añadir contenido a una página de endpoint:
- Navega a la documentación de la API ({ }) en la barra de navegación izquierda.
- Abre el artículo final que quieres editar.
- Haz clic en el icono (+) para insertar un bloque de editor debajo del contenido generado por la especificación.
- Introduce tu contenido y formatea usando las opciones de la barra de herramientas.
Tu contenido se guarda automáticamente.
Barra de herramientas del editor
La barra de herramientas avanzada del editor WYSIWYG incluye opciones de formato para el estilo de texto, listas, imágenes, enlaces y más. También puedes escribir / para acceder a comandos de barra y así insertar rápidamente encabezados, listas y otros elementos. Usa atajos de teclado y la tecla Tab para moverte rápidamente entre las opciones de la barra de herramientas y los elementos del editor. El editor también permite opciones mejoradas de edición y formato para los enlaces.
Cada bloque de editor tiene un límite de caracteres de 500.000 caracteres. El contenido personalizado añadido a las páginas de endpoint se conserva cuando regeneras o resincronizas la documentación de la API.
Configuración del artículo
Cada artículo final tiene un panel de configuración de artículos accesible desde el icono (⋯) en la barra de navegación superior del editor. Esto te da acceso a opciones adicionales de configuración para el artículo.
Dado que cada uno de estos entornos tiene su propio artículo dedicado, esta sección ofrece una breve visión general y enlaces a la documentación relevante.
| Ambientación | Qué hace |
|---|---|
| Recordatorio de la reseña | Establece un recordatorio para revisar el artículo en intervalos específicos, ya sea marcándolo para revisión o programando un recordatorio. |
| Campos personalizados | Añade campos de metadatos personalizados al artículo. |
| GEO/SEO | Configura la configuración de SEO incluyendo metatítulos, descripción y geosegmentación. |
| Visibilidad en búsquedas | Controla si el artículo aparece en los resultados de búsqueda. |
| Etiquetas | Añade etiquetas al artículo para mayor descubrimiento. |
| Sellos | Aplica etiquetas para categorizar y filtrar artículos. |
| Artículos relacionados | Enlaza artículos relacionados que los lectores puedan encontrar útiles. |
| Imagen destacada | Crea una imagen destacada para el artículo. |
| Accesorios | Añade archivos adjuntos al artículo. |
| Indicador de estado | Configura un indicador de estado para señalar el estado del artículo. |
| Preferencias | Configura las preferencias a nivel de artículo. |
| Tipo de editor | Cambia entre tipos de editor para el artículo. |
| Marca como obsoleto | Marca el artículo como obsoleto para señalar que ya no se mantiene activamente. |
Para instrucciones detalladas sobre cada entorno, consulte el artículo sobre gestión de artículos .
Opciones de artículos de endpoint
Al hacer clic derecho en un artículo final en el panel de Categorías y Artículos te ofrece las siguientes opciones:
| Opción | Qué hace |
|---|---|
| Publicar | Publica el artículo de endpoint en la página de la base de conocimiento. |
| Publicación posterior | Programa la publicación del artículo en una fecha y hora específicas. |
| Renombración | Renombra el artículo de endpoint. |
| Seguridad | Configura quién puede acceder al artículo tanto desde el portal como desde la base de conocimientos. |
Debates
El panel de discusión te permite mantener conversaciones directamente con tu equipo sobre un artículo de endpoint. Esto es útil para dejar comentarios, señalar problemas o coordinar actualizaciones sin dejar la documentación.
Para abrir el panel de Discusión, haz clic en el icono de Discusión en la barra de navegación superior del editor. Puedes iniciar una nueva conversación y usar @ para mencionar a un miembro específico del equipo.
Preguntas frecuentes
¿Se conserva el contenido personalizado cuando resincronizo la documentación de mi API?
Sí. Cualquier contenido personalizado que añadas a los artículos de endpoint se conserva cuando regeneras o resincronizas la documentación de tu API. Solo se actualiza el contenido generado por especificaciones.
¿Puedo descargar artículos en formato PDF usando la API?
Actualmente no hay opción para descargar artículos en formato PDF a través de los endpoints de la API.