SmartDocs se instala automáticamente cuando instalas y ejecutas las secuencias de comandos de prueba de instalación
como se describe en Cómo probar la instalación. Como parte de la ejecución de la prueba
secuencias de comandos, debes ejecutar los siguientes comandos:
configFile es el mismo archivo de configuración que usaste para instalar Edge.
Consulta Instala componentes de Edge en un nodo para obtener más información.
Este comando instala SmartDocs como parte de la ejecución de las pruebas.
Para completar la instalación, sigue estos pasos:
Para probar que SmartDocs esté instalado, confirma que el archivo smartdocs.zip esté
ubicado en el siguiente directorio:
/opt/apigee/apigee-validate/bundles/
También puedes ejecutar la siguiente llamada a la API en el nodo del servidor de administración:
Este comando debería mostrar lo siguiente si SmartDocs está instalado:
[ "smartdocs", "passthrough" ]
Desde la IU de Edge, crea y actualiza un KVM llamado “smartdocs_whitelist”, como se muestra en la siguiente figura.
El KVM debe crearse en la organización y en el entorno donde se ejecuta el proxy de SmartDocs.
implementados en ese momento.
Nota: Asegúrate de que la casilla Encriptado NO esté marcada.
Agrega una clave llamada “is_whitelist_configuration”, cuyo valor es “YES”.
Agrega una segunda clave llamada “allowed_hosts”, en la que los valores son nombres de host o direcciones IP separados por espacios
llamado desde SmartDocs. El valor de "allowed_hosts" debe incluir cualquier host incluido en las especificaciones de OpenAPI
agregados a SmartDocs. Por ejemplo, si tienes una especificación de OpenAPI que llama a mocktarget.apigee.net,
deberás agregar mocktarget.apigee.net a "allowed_hosts" valor. Si un host no es
incluido en el KVM, la respuesta de SmartDocs será 400 Bad Request con un
de Bad Request-Hostname not permitted.
Nota: Si no agregas ni configuras este KVM, el proxy no aplicará la lista blanca de manera forzosa. Esta
podría ocasionar un acceso no autorizado a sus hosts y direcciones IP. Solo los nombres de host y las direcciones IP de
Los extremos de la API documentados con SmartDocs deben incluirse en la carpeta “allowed_hosts” de salida.