Prácticas recomendadas para compilar tu portal

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

Apigee recomienda que apliques las prácticas recomendadas que se describen en las siguientes secciones cuando crees tu portal.

Haz participar a tu público

Agrega contenido que atraiga a tu público de manera visual y los motive a querer obtener más información. Permite que los consumidores de API exploren una parte de tu portal sin que tengan que acceder a sus cuentas. Proporciona un registro de autoservicio para que puedan comenzar a compilar rápidamente apps mediante tus API.

Deja que los usuarios prueben tus API

Genera de forma automática la documentación interactiva de la API a partir de tus especificaciones de OpenAPI para permitir a los usuarios hacer lo siguiente:

• Obtener información sobre la API
• Envía una solicitud a la API.

• Visualiza una respuesta en vivo que muestra la API

  Para obtener más información, consulta Publica tus APIs.

Aborda las rutas de aprendizaje principales

Proporciona instructivos y ejemplos de casos de uso que sean relevantes para tu público y según su nivel de experiencia. Demuestra mediante un ejemplo, como una secuencia de comandos curl simple, o exhibe un procedimiento más detallado.

Implementa la optimización para motores de búsqueda (SEO)

Asegúrate de que tu contenido se pueda buscar. Invierte en SEO que mejore tu clasificación en los resultados de la búsqueda y permita que los usuarios encuentren tu contenido.

Usa las siguientes recomendaciones para estructurar tu contenido. Para obtener más información y lineamientos adicionales de Google, consulta la Guía de inicio de optimización para motores de búsqueda de Google.

Práctica recomendada	Descripción	Ventajas
Crea URL fáciles de usar	Crea URLs legibles y fáciles de entender. Define una URL de página fácil de usar cuando agregues páginas a tu portal, como se describe en Crea una página.	Transmite el propósito de la página de una forma legible. La coincidencia completa o parcial de las palabras clave en la URL de la página mejora la clasificación de búsqueda. Por lo general, las URL aparecen en los resultados de la búsqueda.
Proporciona un nombre descriptivo del portal	Define un nombre de portal único y descriptivo para tu portal, como se describe en Administra tus portales. Este contenido se usa para propagar la etiqueta <title> de la página principal (index) de tu portal.	La coincidencia completa o parcial de las palabras clave en el título mejora la clasificación de búsqueda. Por lo general, el contenido de los títulos de tus páginas se muestra como la primera línea de los resultados de la búsqueda.
Facilita la navegación en tu sitio	Define una estructura de navegación que tenga sentido lógico, como se describe en Configura la navegación.	Haz que los usuarios se sientan orientados. Ayuda a los usuarios a encontrar el contenido que desean con rapidez y facilidad.
Usa una buena combinación de frases de palabras clave en todo el contenido	Incluye palabras clave en tu contenido cuando sea relevante y tenga sentido hacerlo. La importancia de una string de palabras clave en tu página puede mejorar la clasificación de la página en los resultados de la búsqueda. Intenta predecir las strings de palabras clave que los usuarios podrían usar cuando busquen tu contenido. Ten cuidado de no usar demasiadas palabras clave, es decir, usar muchas palabras clave con el único propósito de mejorar la clasificación de búsqueda. Esto podría provocar que los motores de búsqueda penalicen tu sitio.	Es más probable que los usuarios que buscan contenido obtengan resultados relevantes.

Crea una comunidad de desarrolladores

Usa las redes sociales para promocionar tu comunidad de API a través de canales sociales estándar, como Facebook, Twitter, etcétera. Publica blogs y foros que fomenten la comunicación y la interacción entre los desarrolladores de tu comunidad de API.