Estás consultando la documentación de Apigee Edge.
Consulta la
documentación de Apigee X. Información
Como proveedor de APIs, necesitas una forma de exponer tus APIs, educar a los desarrolladores sobre ellas, registrar desarrolladores y permitir que los desarrolladores registren apps. Apigee Edge te proporciona un portal de servicios para desarrolladores que puedes usar a fin de compilar y lanzar tu propio sitio web personalizado para proporcionar estos servicios a tu comunidad de desarrollo. Si deseas obtener más información sobre los portales para desarrolladores, consulta ¿Qué es un portal para desarrolladores?
En las siguientes secciones, se describen conceptos clave que debes comprender antes de solucionar problemas en tu portal para desarrolladores.
Cómo funciona SmartDocs
Puedes importar a SmartDocs una especificación de OpenAPI (JSON o YAML) o WADL que describa tu API y usarla para publicar la documentación de referencia de la API en tu portal. La documentación de referencia de la API aparece automáticamente en la pestaña APIs de tu portal. Los desarrolladores descubren la documentación de la API a través del portal y pueden realizar solicitudes a la API en vivo. Como las solicitudes a la API se originan en un navegador, se necesita compatibilidad con CORS (uso compartido de recursos entre dominios) para que tengan éxito. La compatibilidad con CORS la proporciona el proxy “smartdocs” en Edge (en la organización “VALIDATE”) que actúa como proxy para todas las solicitudes de SmartDocs al extremo previsto. El proxy de "smartdocs" se crea cuando instalas SmartDocs.
Por ejemplo:
La URL del proxy de SmartDocs se expone como una propiedad configurable en Configuración -> SmartDocs -> URL del proxy de SmartDocs. Es posible que debas modificar esta URL si tu API está en una red privada y las solicitudes a la API activas que usan SmartDocs desde tu portal fallan.
Cómo se comunica el portal para desarrolladores con Edge
El portal para desarrolladores almacena y recupera la mayor parte de la información que muestra de Edge, incluidas Smartdocs, los desarrolladores, los productos y las apps para desarrolladores. La información de la organización perimetral y las credenciales de administrador del desarrollador se pueden configurar mediante el comando de menú Configuración -> Devportal.
Para obtener más información, consulta la sección Comunicación entre el portal y Edge.