7. Crear servicios con OData

Como se explico en el capítulo 2 en la explicación de servicios REST para quienes consuman tus servicios puedan filtrar la información o selecionar solamente algunos campos de una tabla se utiliza un protocolo llamado OData (Open Data Protocol).

De momento la documentación con Swagger no es muy compatible con OData por lo cual los servicios se deben probar con postman.

Las opciones dispnibles son:

Opción

Descripción

$select=clave,nombre

Seleccionar los campos de la tabla que deseas obtener en el servicio. En este ejemplo solo se seleccionan los campos de clave y nombre.

$orderby=clave desc

Ordenar el resultado por el campo clave de forma descendente

$filter=clave gt 10

Permite filtrar los resultados. En este ejemplo se regresan los registros en el cual la clave sea mayor a 1

$skip=4

Permite omitir los primeros 4 registros, lo puedes combinar con $orderby

$top=10

Obtiene los primeros 10 registros

$count=true

Regresa también el total de registros

productos$expand=clientes

Permite además de obtener los productos obtener los datos de los clientes.

Puedes ver la documentación de OData con todas las opciones disponibles aquí

Puedes consultar la documentación oficial de Microsoft aquí