SmartDocs se instala automáticamente cuando instalas y ejecutas las secuencias de comandos de prueba de instalación que se describen en Cómo probar la instalación. Como parte de la ejecución de las secuencias de comandos de prueba, ejecuta 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 Cómo instalar componentes de Edge en un nodo para obtener más información.
Con este comando, se instala SmartDocs como parte de la ejecución de las pruebas.
Para completar la instalación, haz lo siguiente:
Para comprobar que esté instalado SmartDocs, confirma que el archivo
smartdocs.zip
se encuentre 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" ]
- 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 actualmente el proxy de SmartDocs.
Nota: Asegúrate de que la casilla encriptado NO esté marcada.
- Agregue una clave denominada "is_whitelist_configured" (el valor es "YES").
- Agrega una segunda clave llamada “allowed_hosts”, en la que los valores sean nombres de host o direcciones IP separados por espacios llamados 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 agregarmocktarget.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 deBad Request-Hostname not permitted
.