SOAP .:. Servicio Web en c#

SOAP (Simple Object Access Protocol) es un protocolo estándar que define cómo dos objetos en diferentes procesos pueden comunicarse por medio de intercambio de datos XML (Lenguaje de Marcado Extensible). Básicamente SOAP es un paradigma de mensajería de una dirección sin estado, que puede ser utilizado para formar protocolos más complejos y completos según las necesidades de las aplicaciones que lo implementan. Puede formar y construir la capa base de una «pila de protocolos de web service», ofreciendo un framework de mensajería básica en el cual los web services se pueden construir.

En esta oportunidad construiremos un sencillo Web Service en C#utilizando Visual Studio 2015

Necesitamos

• Visual Studio 2015
• Conocimientos en C# y XML
• Navegador web

Tiempo: 15 minutos

Paso 1: El Proyecto Web

Clic en Archivo → Nuevo → Sitio Web → a continuación seleccionar la opción de Sitio Web Vacio de ASP.NET

Indica la ubicación del sitio web y escribe como nombre «EjemploSOAP«, para crear el proyecto, clic en [Aceptar]

Paso 2: El Servicio Web

Clic derecho sobre el proyecto → Agregar → Agregar nuevo elemento…  → Seleccionar Servicio Web (ASMX), como nombre del servicio escribir «WSMateMata.asmx»

clic en [agregar] para añadir el Servicio Web al proyecto.

*.asmx es un archivo de texto que sirve de punto de entrada direccionable del servicio web. Hace referencia al código de ensamblados precompilados, a un archivo de código subyacente o a un código contenido en el propio archivo .asmx.

La clase WSMateMata.cs que se agrego, es la siguiente:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;

/// <summary>
/// Descripción breve de WSMateMata
/// </summary>
[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
// Para permitir que se llame a este servicio web desde un script, usando ASP.NET AJAX, quite la marca de comentario de la línea siguiente. 
// [System.Web.Script.Services.ScriptService]
public class WSMateMata : System.Web.Services.WebService {

    public WSMateMata () {

        //Elimine la marca de comentario de la línea siguiente si utiliza los componentes diseñados 
        //InitializeComponent(); 
    }

    [WebMethod]
    public string HelloWorld() {
        return "Hola a todos";
    }
    
}

Esta clase cuenta con un solo método por defecto, el clásico «Hola mundo«, ya podríamos ejecutarlo y probarlo, pero, cambiaremos el código por el siguiente:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;

/// <summary>
/// Descripción breve de WSMateMata
/// </summary>
[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class WSMateMata : System.Web.Services.WebService {

    public WSMateMata () {}

    /// <summary>
    /// Retorna un numero entero aleatorio entre 1 y 100
    /// </summary>
    [WebMethod]
    public int numeroAleatorioDe1a100() {
        Random rnd = new Random();
        return rnd.Next(1, 100);
    }
    
    /// <summary>
    /// suma dos numeros enteros    
    /// </summary>
    ///<param name="sumando1">Sumando 1</param>
    ///<param name="sumando2">Sumando 2</param>
    /// <returns>resultado</returns>
    [WebMethod]
    public int suma(int sumando1, int sumando2) {        
        return sumando1 + sumando2;
    }

}

este nuevo código consta de dos métodos «numeroAleatoriode1a100» sin parámetros de entrada y «suma«, con dos parámetros de entrada.

Paso 3. Ejecución

Seleccionamos el navegador que usaremos

y luego ejecutamos el proyecto.

Se nos presenta una pagina web, con los dos métodos más arriba declarados, para poder probarlos, solo debemos hacer clic en cualquiera de ellos.

numeroAleatorioDe1a100: Sin parámetros de entrada retorna un valor entero aleatorio al presionar [invocar]

Al presionar el botón se abre una nueva ventana con el resultado en formato XML

suma: con dos parámetros de entrada, para realizar la prueba presionamos [invocar]

Al igual que el anterior método, el resultado se abre en una nueva ventana

Los anteriores métodos los probamos mediante el protocolo HTTP POST con las mismas herramientas que nos brinda Visual Studio, sin embargo para implementar este servicio web en un cliente, necesitaremos de un archivo *.wsdl, el cual es también generado por Visual Studio.

WSDL

WSDL (Web Services Description Language), es un formato del Extensible Markup Language (XML)  y que nos sirve para describir la interfaz pública a los Servicios Web,  es decir, los requisitos del protocolo y los formatos de los mensajes necesarios para interactuar con los servicios listados en su catálogo.

Para acceder al WSDL de este proyecto, clic en «descripción de servicios» el cual tiene un link de la siguiente forma: «http://localhost:7783/WSMateMata.asmx?WSDL», es este archivo el que usa el cliente para poder configurar y usar el servicio web. Pero eso lo veremos en otra oportunidad.

Enjoy!!!