Estándares en servicios web


Estándares para Servicios Web













Aprobaciones
Preparado por:
Fecha:
Revisado por:
Fecha:
Aprobado por:
Fecha:
Armando Rivas
05.11.2012
Armando Rivas


















Control de Versiones
No. Versión
Detalle del cambio
Preparó
Revisó
Fecha
0.0
Creación del documento
Armando Rivas














Contenido


ote: Toupdate the table of contents, put the cursor anywhere in the table and press [F9]. To change the number of levels displayed, select the menu option Insert>Index and Tables, make sure the Table of Contents tab is active, and change the Number of Levels to a new value.


Introducción

Propósito
Este documento describe los estándares que el proyecto deberá seguir para la construcción ymodificación de servicios Web. Estos estándares solo serán aplicables y válidos siempre y cuando el cliente no tenga un estándar para la creación de servicios.


Alcance y Aplicación
Los estándares en este documento deberán ser lineamientos a seguir en la etapa de Construcción, y estarán disponibles para todo el equipo de desarrollo, así como para cualquier implementación o mantenimiento que serealice posterior a esta etapa.
En el caso que el cliente nos proporcione sus estándares de desarrollo de servicios Web, deberemos apegarnos a estos lineamientos; sin embargo, queda abierto este documento a utilizar los estándares no mencionados en el documento proporcionado por el cliente.



Definición de Estándares de Servicios Web

Estándar para el diseño de servicios Web.
Patronesaplicables en servicios Web.

Para llevar a cabo la implementación de servicios Web, es necesario hacer uso de los patrones que se mencionan a continuación:
MEP. El mensaje SOAP es una transmisión en un sentido desde el cliente al servidor. Es por ello que el patrón MEP (Patrón de mensaje de intercambio) debe ser implementado por los servicios Web basados en SOAP. Este es un patrón de conversación ypara que se lleve a cabo este intercambio, es necesario que se inicie la conversación una entidad y la termine otra entidad con la respuesta.

XML de entrada y XML de salida (request, response)

Para el diseño de servicios Web que serán creados desde cero, se recomienda que primero se diseñe la estructura del mensaje por la cual se estarán intercambiando información desde el cliente al servidory viceversa. A este tipo de diseño se le conoce como Top-Down. Con este diseño aseguraremos que primero generemos el contrato del WSDL y después implementemos a nivel de código las operaciones del servicio Web. Aunque este diseño es mas complejo que iniciar primero con el código y después con el WSDL, es necesario mantenerlo así porque ayudará a que el intercambio de información entre las partessea completamente transparente y se mantenga la interoperabilidad de sistemas sin la necesidad de depender de un agente externo.
Si son servicios web existentes, entonces hay que apegarse a las reglas de como fueron construidos con la finalidad de seguir manteniendo el diseño que se planteó desde un principio.
Para el diseño, será necesario especificar un XML válido de acuerdo a la especificaciónmencionada en el siguiente enlace: http://www.w3.org/TR/REC-xml/ y complementarlo con los puntos que se describen a continuación.

1.- Nomenclatura de elementos del XML de request y response. Los nombres de los elementos del XML de request y response deberán de mantener un estándar en su nombramiento. El nombre del elemento deberá iniciar con minúscula. Las minúsculas deberán prevalecer en todoel nombre del elemento y si es necesario expresar palabras o expresiones compuestas como parte de su nombre entonces deberán estar separados por un guion medio. Esta misma regla aplica también para atributos de los elementos. Considere los siguientes ejemplos:


Imagen . Nomenclatura en los elementos del xml.

Evite iniciar con mayúsculas y también la notación que comúnmente se usa en Java...