Histórico da Página

El estándar para la documentación de las API utilizado es el OpenAPI v3.

Para agilizar la documentación tenemos la herramienta de la Ingeniería con interfaz gráfica en el enlace:  OpenAPI-GUI v3

Otra herramienta es la extensión OpenAPI del VSCode. En esta podemos escribir el archivo yml y visualizar utilizando el Swagger UI.

Definición...

Ejemplo:

Vea los siguientes enlaces de acceso a los documentos de las FAQ de Productos del BackOffice, desarrollados en el PO UI con el  público objetivo general, es decir, se destina a Desarrolladores, Soporte Técnico y también a Clientes:

FAQ - Dashboard BackOffice

FAQ - Portal Gestión de Ventas

FAQ - Seguimiento de Costos (OBS: Al final de la página)

Vea los siguientes enlaces de acceso a los documentos de una FAQ destinada al equipo de Soporte Técnico, para apoyo a la atención de tickets de clientes:

PO UI - Documento de apoyo al soporte