¿Por qué esta consulta de OData con $ count = true devuelve un objeto?

Estoy tratando de averiguar cómo admitir correctamente la devolución de la cantidad de elementos en un conjunto de datos (filtrado) en mi API de OData.

Tengo entendido que agregar el $count=trueargumento a la cadena de consulta debería permitir esto.

Ahora, según el ejemplo del tutorial en los documentos oficiales , agregar ese parámetro debería hacer que la API web devuelva solo un número entero:

La siguiente solicitud devuelve el número total de personas de la colección.

GET serviceRoot/People?$count=true

Carga de respuesta

20

Por otro lado, esta respuesta ¹ aceptada y bastante votada indica que una consulta con $count=truedevolverá un objeto , una de cuyas propiedades contiene dicho número entero. Proporciona una consulta ejemplar en un punto final de muestra:

https://services.odata.org/V4/Northwind/Northwind.svc/Customers?$count=true&$top=0&$filter=Country eq 'Germany'

De hecho, el resultado real de ese punto final es el objeto complejo

{
  "@odata.context": "https://services.odata.org/V4/Northwind/Northwind.svc/$metadata#Customers",
  "@odata.count": 11,
  "value": []
}

en lugar del resultado esperado de un solo número entero

11

¿Por qué es esto? ¿Estoy entendiendo mal la documentación?

¹ : La respuesta tenía 25 votos a favor al momento de escribir este artículo.

El problema principal es que la especificación OData v4 es un estándar en evolución, ya que muchas implementaciones manejan algunas solicitudes de manera diferente, ya sea porque el estándar ha cambiado o porque el estándar era difícil de implementar o el comportamiento sugerido en la especificación no se ajusta al resto. de las convenciones.

¿Por qué es esto? ¿Estoy entendiendo mal la documentación?

Entonces, su problema principal es que estaba leyendo la documentación incorrecta para la API que estaba consultando. Es importante reconocer que con cada implementación de un estándar depende del desarrollador elegir qué tan conformes con ese estándar son, por lo que debe leer la documentación que va específicamente con esa API.

Esta es la especificación en cuestión para OData v4:

4.8 Abordar el recuento de una colección
Para abordar el valor bruto del número de elementos en una colección, los clientes agregan / $ count a la ruta de recursos de la URL que identifica el conjunto de entidades o la colección.

Los /$countruta sufijo identifica el recuento de número entero de registros de la recolección y no se debe combinar con las opciones de consulta del sistema $top, $skip, $orderby, $expand, y $format. El recuento no deben verse afectadas por $top, $skip, $orderby, o $expand. El recuento se calcula después de aplicar los /$filtersegmentos de ruta $filtero las $searchopciones de consulta del sistema a la colección.

En la implementación de .Net, dado que $countes el resultado de una consulta, debe evaluarse como parte de la canalización de opciones de consulta, no como parte de la ruta.

Opciones de consulta de MS OData: recuento
La $countopción de consulta del sistema permite a los clientes solicitar un recuento de los recursos coincidentes incluidos con los recursos en la respuesta. La opción de consulta $ count tiene un valor booleano de verdadero o falso.

Ejemplos:

• Devuelve, junto con los resultados, el número total de productos de la colección. http://host/service/Products?$count=true
• El recuento de entidades relacionadas se puede solicitar especificando la $countopción de consulta dentro de la $expandcláusula.http://host/service/Categories?$expand=Products($count=true)

Desde el punto de vista de la implementación, mezclar esta opción de consulta en la ruta rompe la convención utilizada para todos los demás procesamientos y análisis de URL, realmente es la extraña. ruta y consulta.

Respecto a la respuesta del objeto

En la implementación de .Net, debido a que $countes compatible con expansiones de colecciones, así como en la raíz (ver el segundo ejemplo), han optado por inyectar el valor como metadatos / atributos mezclados con los resultados. De esa manera, la respuesta seguirá siendo válida para fines de serialización y el comportamiento del recuento volverá a ser coherente donde sea que se utilice.

Este último ejemplo lo dejo de una de mis propias API, demostrando la respuesta de atributo para colecciones expandidas, si $count=trueno devolviera el gráfico de objeto, no podría llegar a los recuentos de las expansiones en absoluto:

https://localhost/OData/Residents?$count=true&$expand=Entity($select=Id;$expand=Contacts($count=true;$top=0))&$select=id&$top=2

{
    "@odata.context": "https://localhost/odata/$metadata#Residents(Id,Entity(Id,Contacts()))", "@odata.count": 29, "value": [ { "Id": 13110, "Entity": { "Id": 13110, "[email protected]": 6, "Contacts": [] } }, { "Id": 13164, "Entity": { "Id": 13164, "[email protected]": 6, "Contacts": [] } } ], "@odata.nextLink": "localhost/OData/Residents?$expand=Entity%28%24select%3DId%3B%24expand%3DContacts%28%24count%3Dtrue%3B%24top%3D0%29%29&$select=id&$top=2&$skip=2"
}