¡Esta es una revisión vieja del documento!
Esta sección describe la plantilla para la documentación de los servicios web.
En esta zona se debe diligenciar la tabla de información relacionada con el servicio. A continuación se describen las columna definidas.
Nombre | Descripción | Tipo Servicio | Tecnología | Lenguaje | Tipo Desarrollo | Versión Desarrollo | Archivo de Configuración | |
---|---|---|---|---|---|---|---|---|
Nombre del Servicio | Descripción del Servicio. | Tipo de Servicio [Rest, SOAP] | Framework utilizado en la construcción del servicio | Lenguaje de programación utilizado para la construccción del servico | Tipo de desarrollo de la solución: [Nuevo,Legado] | Versión del desarrollo debe seguir el estandar de Versionamiento del Software | Archivo principal de configuración del proyecto | |
Patron de Diseño | Tipo Empaquetado | Gestor de Dependencias | Servidor de Despliegue | IDE Proyecto | Tipo Repositorio | Url Desarrollo | Url Calidad | Url Producción |
Indica el tipo de patron de diseño utilizado en la solución. | Tipo Empaquetado del software. Ejemplo Java: [jar, war] | Gestor de Dependencias utilizado para el proyecto: [Maven,Gradle] con su respectiva versión | Servidor de despliegue utilizado [tomcat, jboss, wildfly] con su respectiva versión | Entorno de desarrollo utilizado [Eclipse,STS,Netbeans, IntelliJ, VisualStudioCode] con su respectiva versión | Control de versiones utilizado [Subversión, Git, Gitlab] con su respectiva versión | Ruta desarrollo | Ruta Calidad | Ruta Producción |
Dependencias: Ejemplo Maven | ||||||||
groupId | artifactId | version | scope | optional | Descripción | |||
Grupo | Artefacto | Versión Artefacto | Ambito | Opciones | Descripción de la dependencia | |||
Operaciones | ||||||||
Tipo Petición Http | Nombre operación | Descripción | Documentación | |||||
Verbo Http [POST,PUT,GET,DELETE] | Nombre de la operación del servicio | Descripción de la operación del servicio | Url de documentación de la operación | |||||
Ambientes de Despliegue | ||||||||
Tipo | Url | Observaciones | ||||||
Tipo de Ambiente [Desarrollo, Calidad, Producción] | Ruta base del servicio | Descripción del ambiente |
Esta zona se define con el fin de adicionar información complementaria al servicio (si es requerido).