====== Fábrica - Servicios Web - Integraciones - Consultar Documentación Swagger ====== Esta sección describe el proceso de consulta de la documentación en el visor swagger. La cual provee infromación relacionada con el contrato del servicio, es decir, define los métodos expuestos y su estructura de consumo. Esta documentación es conocida como documentación externa ya que ayuda a los equipos a identificar el API, abstrayendo la logica del negocio. ===== Consultar Documentación Swagger ===== === Pasos Previos === * El servicio debe estar configurado para generar la documentación swagger. ==== Visualziar la documentación en el visor Swagger ==== Siga los siguientes pasos: * En la documentación del servicio se anexará una url donde se puede consultar la documentación en formato json. Por lo general el path de esta documentacion estará en /api-docs o /v3/api-docs. Ejemplo http://localhost:8080/api-docs o http://localhost:8080/v3/api-docs * Copiar el contenido que se visualiza en la url consultada * Abrir el navegador e ir a la url https://editor.swagger.io/ * Copiar limpiar el contenido de la zona izquierda de la pantalla (vista desde el usuario). * Pegar el contenido generado en la url /apidocs de paso 1 * En la zona de la derecha del visor (vista desde el usuario). se Visualziará la documentación del servicio. [[ada:howto:sicoferp:factory:integrations|←Volver atras]]