Árbol de páginas

Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

Si en nuestro pórtico se generan proyectos que ofertan servicios a otros grupos vía REST, SOAP o RMI el el Responsable técnico asegurará que los Miembros del equipo de desarrollo documenten las diferentes APIs generadas de manera que cualquier grupo pueda utilizarlas sin dificultad. En el caso de que las API requieran autenticación gestionada por el proyecto, el Responsable técnico definirá el proyecto Jira al que los grupos clientes deberán registrar las solicitudes de alta de sus aplicaciones.

Para los diferentes tipos de API, los Miembros del equipo de desarrollo deberán documentar los métodos ofrecidos y la forma de acceso a los mismos en la sección Documentación técnica > APIs de servicios > REST | SOAP | RMI 

En el caso de que sea una API REST o SOAP se deberá generar previamente la pertinente documentación con Enunciate o similar para enlazarla a la correspondiente ficha.

A su vez los Miembros del equipo de desarrollo deberán asegurar que dicha información está actualizada, llevando un control de cambios y marcando los métodos que entren en desuso con la pertinente etiqueta. El Responsable técnico deberá comprobar el estado de dicha documentación antes de cada actualización del proyecto o proyectos incluidos en el pórtico. También deberá notificar a todos los grupos los cambios en cada versión de la API para planificar las actualizaciones que sean necesarias en las aplicaciones clientes,