viernes, septiembre 17, 2021

Cómo retornar JSON desde un WebService en .NET

JSON es uno de los protocolos de intercambio de datos mas populares y eficientes del momento, saber como exportar nuestros datos desde .NET es muy importante. En este ejemplo explicamos como exportar estos datos en un Webservice.

Generalmente estamos acostumbrados a que los Webservices exporten datos como XML, Datasets, o datos directos como enteros, strings y demás tipos. Pero que pasa si queremos exportar los datos en formato JSON.

Primero necesitamos la librería correspondiente y la cual esla mas recomendada en estos momentos Json.NET (http://james.newtonking.com/projects/json-net.aspx  o http://json.codeplex.com). Esta librería la importamos en las referencias de la aplicación.

Ahora en nuestra aplicación creamos un nuevo archivo Webservice. Lo mas probable es que se va a generar el siguiente código:

ImportsSystem.Web

ImportsSystem.Web.Services

ImportsSystem.Web.Services.Protocols

'To allow this Web Service to be called from script, using ASP.NET AJAX,uncomment the following line.

'<System.Web.Script.Services.ScriptService()> _

<WebService(Namespace:="http://tempuri.org/")>_

<WebServiceBinding(ConformsTo:=WsiProfiles.BasicProfile1_1)> _

<Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()> _

PublicClass WebService

     InheritsSystem.Web.Services.WebService

    <WebMethod()>_

    Public Function HelloWorld() AsString

        Return "Hello World"

    End Function

EndClass

Ahora agregamos las referencias

Imports Newtonsoft.Json

Imports System.Web.Script.Services

Le quitamos el comentario donde dice

<System.Web.Script.Services.ScriptService()> _

Agregamos el siguiente procedimiento

<WebMethod(CacheDuration:=0)> _

<Script.Services.ScriptMethod(ResponseFormat:=ResponseFormat.Json,UseHttpGet:=True, XmlSerializeString:=False)> _

Public Sub GetDatosJSON(ByValvalor1 As Integer,ByVal valor2 AsInteger)

    Dim iDatosAs New MisDatos

    Context.Response.Cache.SetExpires(DateTime.Now.AddHours(-1))

    Context.Response.ContentType = "application/json"

    Context.Response.Write(Newtonsoft.Json.JsonConvert.SerializeObject(

                                       iDatos.GetDataSet(valor1,valor2),

                                       Newtonsoft.Json.Formatting.None))

    Context.Response.Flush()

    Context.Response.End()

End Sub

Como podemos ver le indicamos la duración del cache, la cualla ponemos en 0, también le indicamos los métodos de script, Json y le especificamos que NO es XMLSerialize.

Ahora en el código le definimos el Content Type donde le especificamos que es application/json que es el tipo de datos que vamos a retornar, que aunque es texto puro, es mejor definirlo de esta manera.

Luego utilizamos el método Newtonsoft.Json.JsonConvert.SerializeObjecty le enviamos nuestro Dataset, el componente se encargará de hacer el resto.

Como podemos ver le definimos Formattin.None esto se hace cuando ya hemos pasado las etapas de desarrollo y estamos seguros de como se retornan los datos. Con esta propiedad el resultado va a ser texto sin formato, se eliminan los espacios en blanco, los innecesarios obviamente, y prácticamente que todo el resultado queda en una sola línea string. Si le definimos Formatting.Indented el resultado será ordenado para la vista y para entender los datos, pero consume mucha más memoria que el formato sin identar. Entonces cuando ya uses la aplicación en producción usa Fomatting.none

Obtendremos un resultado similar a:

{«Referencias»:[{«codigo»:123,»descripcion»:»Ejemplo Descripcion»}]}




Roy Rojashttp://www.dotnetcr.com
Con más de 20 años de experiencia en programación, experto en lenguajes .NET, VB, C#, ASP.NET, Xamarin, XCode, DBA en SQL Server. Creador de dotnetcr.com, sitio web para programadores en español. royrojas.com | dotnetcr.com | GitHub

Redes Sociales

2,736FansMe gusta
326SeguidoresSeguir

Popular esta semana

SQL Server - Merge

MERGE en SQL Server para Insert, Delete y Update con dos tablas

Ejemplo práctico usando MERGE para sincronizar dos tablas, Insert, Update y Delete en un solo query. Válido para SQL SERVER 2008 o superior.

Calcular la distancia entre dos puntos geográficos en SQL Server

En este ejemplo mostramos como calcular la distancia en metros o kilómetros entre dos puntos geográficos, por latitud y longitud. El resultado lo obtenemos en metros o kilómetros.

DELETE con subconsulta o INNER JOIN

En el siguiente ejemplo se explica la forma en que se pueden eliminar registros en nuestras tablas con instrucciones DELETE más complejas que las...

Últimos artículos

Flutter - Instagram Clone App

Instagram Clone App con Flutter

Marvin Stanley Valenzuela nos comparte un reto y genialidad a la vez, excelente práctica de la que podemos aprender mucho, diseñó en...

¿Cómo agregar una IP adicional en una VM Ubuntu en Azure?

Lo más común al momento de crear y configurar un nuevo servidor es que a este le asigne un solo IP, pero...
flutter one year

Después de un año con Flutter, esto es lo que aprendí

La historia comenzó cuando un día desperté pensando en tener un nuevo proyecto personal. Me dije a mí misma que hay muchas...
promocionar app

Cómo promocionar gratis tu app usando tappx

Como todos los que me siguen y mis redes sociales sabrán, recientemente lancé mi primera aplicación, pero más allá del desafío tecnológico de...