Estás viendo la documentación de Apigee Edge.
Ir a la
documentación de Apigee X. info
Como proveedor de API, necesitas una forma de exponer tus APIs, educar a los desarrolladores sobre ellas, registrarlos y permitirles registrar apps. Apigee Edge te proporciona un portal de servicios para desarrolladores que puedes usar para crear y lanzar tu propio sitio web personalizado para proporcionar estos servicios a tu comunidad de desarrollo. Para obtener más información sobre los portales para desarrolladores, consulta ¿Qué es un portal para desarrolladores?
En las siguientes secciones, se describen los conceptos clave que debes comprender antes de solucionar problemas con tu portal para desarrolladores.
Cómo funciona SmartDocs
Se puede importar una especificación de OpenAPI (JSON o YAML) o WADL que describa tu API a SmartDocs 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 de API en vivo. Como las solicitudes de API provienen de un navegador, se necesita compatibilidad con CORS (uso compartido de recursos entre dominios) para permitir que se realicen correctamente. 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 deseado. El proxy "smartdocs" se crea cuando instalas SmartDocs.
Por ejemplo:
La URL del proxy de smartdocs se expone como una propiedad configurable en Configuration -> SmartDocs -> SmartDocs proxy URL. Es posible que debas modificar esta URL si tu API está en una red privada y fallan las solicitudes de API en vivo que usan SmartDocs desde tu portal.
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 desde Edge incluidos Smartdocs, desarrolladores, productos y apps para desarrolladores. La información de la organización de Edge y las credenciales de devadmin se pueden configurar con el comando de menú Configuration -> Devportal.
Para obtener más información, consulta Comunicación entre el portal y Edge.