Prácticas recomendadas para crear un portal

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Apigee recomienda que aplique las prácticas recomendadas que se describen en las siguientes secciones al crear su portal.

Capta la atención de tu audiencia

Añade contenido que atraiga visualmente a tu audiencia y la anime a obtener más información. Permite que los consumidores de APIs exploren una parte de tu portal sin iniciar sesión. Ofrece un registro de autoservicio para que puedan empezar a crear aplicaciones con tus APIs rápidamente.

Permitir que los usuarios prueben tus APIs

Genera automáticamente documentación interactiva de las APIs a partir de tus especificaciones de OpenAPI para que los usuarios puedan hacer lo siguiente:

• Información sobre la API
• Enviar una solicitud activa a la API

• Ver una respuesta en directo devuelta por la API

  Para obtener más información, consulta el artículo Publicar APIs.

Abordar los planes de formación principales

Proporciona ejemplos de casos prácticos y tutoriales que sean relevantes para tu audiencia y que se adapten a su nivel de experiencia. Demuestra con un ejemplo, como una secuencia de comandos curl sencilla, o sigue un procedimiento más elaborado.

Puedes aprender de tus consumidores internos. Realiza pruebas de usabilidad con consumidores internos y revisa el contenido en función de sus comentarios.

Implementar la optimización en buscadores (SEO)

Asegúrate de que tu contenido se pueda buscar. Invierte en SEO para mejorar tu posicionamiento en los resultados de búsqueda y permitir que los usuarios encuentren tu contenido.

Sigue estas prácticas recomendadas al estructurar tu contenido. Para obtener más información y directrices adicionales de Google, consulta la Guía de optimización en buscadores (SEO) para principiantes.

Práctica recomendada	Descripción	Ventajas
Crear URLs fáciles de usar	Crea URLs fáciles de entender y descriptivas. Define una URL de página intuitiva al añadir páginas a tu portal, tal como se describe en el artículo Crear una página.	Indica el propósito de la página de forma legible. La coincidencia total o parcial de palabras clave en la URL de la página mejora la clasificación de búsqueda. Normalmente, las URLs aparecen en los resultados de búsqueda.
Proporciona un nombre descriptivo para el portal	Define un nombre de portal único y descriptivo para tu portal, tal como se describe en el artículo Gestionar tus portales. Este contenido se usa para rellenar la etiqueta <title> de la página principal (index) de su portal.	La concordancia total o parcial de palabras clave en el título mejora la clasificación en las búsquedas. Normalmente, el contenido de los títulos de las páginas se muestra como la primera línea de los resultados de búsqueda.
Facilita la navegación por tu sitio	Define una estructura de navegación lógica, tal como se describe en Configurar la navegación.	Mantiene a los usuarios orientados. Ayuda a los usuarios a encontrar el contenido que quieren de forma rápida y sencilla.
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 prominencia de una cadena de palabras clave en tu página puede mejorar el posicionamiento de la página en los resultados de búsqueda. Intenta predecir las cadenas de palabras clave que los usuarios podrían usar al buscar tu contenido. No incluyas palabras clave en exceso, es decir, no uses palabras clave de forma excesiva con el único propósito de mejorar la clasificación en las búsquedas. Esto puede provocar que los buscadores penalicen su sitio.	Los usuarios que busquen contenido tendrán más probabilidades de obtener resultados relevantes.

Crea una comunidad de desarrolladores

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