Instala SmartDocs

SmartDocs se instala automáticamente cuando instalas y ejecutas las secuencias de comandos de prueba de instalación que se describen en Prueba la instalación. Como parte de la ejecución de las secuencias de comandos de prueba, ejecutas los siguientes comandos:

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

Donde 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:

1. Para probar que SmartDocs esté instalado, confirma que el archivo smartdocs.zip se encuentre en el siguiente directorio:

   /opt/apigee/apigee-validate/bundles/

   O ejecuta la siguiente llamada a la API en el nodo del servidor de administración:

   curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

   Este comando debería devolver lo siguiente si SmartDocs está instalado:

   [ "smartdocs", "passthrough" ]

2. En la IU de Edge, crea y actualiza una KVM llamada “smartdocs_whitelist”, como se muestra en la siguiente figura. El KVM debe crearse en la organización y el entorno en los que se implementa el proxy de SmartDocs actualmente.

   Nota: Asegúrate de que la casilla Encriptado NO esté marcada.

   • Agrega una clave llamada “is_whitelist_configured”, donde el valor sea “YES”.
   • Agrega una segunda clave llamada “allowed_hosts”, en la que los valores sean nombres de host o direcciones IP separados por espacios que se llamen desde SmartDocs. El valor de "allowed_hosts" debe incluir cualquier host incluido en las especificaciones de OpenAPI agregadas a SmartDocs. Por ejemplo, si tienes una especificación de OpenAPI que llama a mocktarget.apigee.net, deberás agregar mocktarget.apigee.net al valor "allowed_hosts". Si no se incluye un host en el KVM, la respuesta de SmartDocs será 400 Bad Request con una carga útil de contenido de Bad Request-Hostname not permitted.
   Nota: Si no agregas ni configuras este KVM, el proxy no aplicará la lista de entidades permitidas. Esto podría generar un acceso no autorizado a tus hosts y direcciones IP. Solo se deben incluir los nombres de host y las direcciones IP de los endpoints de API documentados con SmartDocs en los valores de "allowed_hosts".