Instala SmartDocs

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:

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

configFile es el mismo archivo de configuración que usaste para instalar Edge. Consulta Cómo instalar 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 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:

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

    Este comando debería mostrar 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 imagen. 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 de encriptado NO esté marcada.

    • Agrega una clave llamada "is_whitelist_configured", en la que el valor sea "YES".
    • Agrega una segunda clave llamada “allowed_hosts”, en la que los valores son nombres de host o direcciones IP separados por espacios a los que se llama desde SmartDocs. El valor de "allowed_hosts" debe incluir todos los hosts incluidos en las especificaciones de OpenAPI que se agregaron 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 un host no es incluido en el KVM, la respuesta de SmartDocs será 400 Bad Request con un de Bad Request-Hostname not permitted.
    Interfaz de creación de KVM Nota: Si no agregas ni configuras este KVM, el proxy no aplicará la lista de entidades permitidas. Esta podría ocasionar un acceso no autorizado a sus hosts y direcciones IP. Solo se deben incluir los nombres de host y las direcciones IP de los extremos de la API documentados con SmartDocs en los valores de "allowed_hosts".