GraphQL
Last updated
Last updated
API de sólo lectura
Acceso público, sin autenticación
Usa GraphQL:
El tamaño máximo (y por defecto) de registros por página es 25
La profundidad máxima de las consultas es de 8 niveles
Como máximo se pueden solicitar 2 colecciones en una misma consulta
Soporte para peticiones GET (consulta dentro del query string) y POST (consulta dentro del body, como application/json
o application/graphql
).
Una de las características que diferencian una API REST de una GraphQL es que con esta última es posible construir consultas personalizadas, de forma que el servidor nos devuelva únicamente la información en la que estamos interesados.
Las consultas en GraphQL están escritas siguiendo un formato que presenta ciertas similitudes con el formato JSON, por ejemplo:
Las respuestas son en formato JSON:
Peticiones GET, con la consulta dentro del query string.
Peticiones POST
Con la consulta dentro del body, con Content-Type: application/json
Con la consulta dentro del body, con Content-Type: application/graphql
Al ser una API que funciona a través de HTTP, cualquier herramienta capaz de realizar este tipo de peticiones resulta válida.
Esta sección contiene algunos ejemplos sobre cómo hacer las peticiones a través de:
GraphiQL
Extensiones de Chrome como Postman
Cualquier librería HTTP
Tiene tres paneles principales:
En el panel de la izquierda se escribe la consulta a realizar.
El panel central muestra el resultado de la petición.
El panel derecho (ocultable) contiene una documentación autogenerada a partir de la información expuesta en la API.
Ejemplo de petición GET
, con la consulta como parte del query string:
Ejemplo de petición POST
, con la consulta como parte del body y codificada como application/json
:
La consulta debe estar ubicada en un documento JSON válido, como valor de la clave "query"
:
Es posible utilizar cualquier librería HTTP de lenguajes de programación.
IMPORTANTE: Algunos servidores podrían tener protocolos de seguridad que hagan necesario incluir un User Agent perteneciente a un navegador para que la petición no sea descartada. Por ejemplo:
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/116.0
El directorio app/graphql/types/
contiene una lista completa de los modelos (y sus campos) que están expuestos actualmente en la API.
La lista de modelos es la siguiente:
User
Usuarios
Debate
Debates
Proposal
Propuestas
Budget
Presupuestos participativos
Budget::Investment
Proyectos de gasto
Comment
Comentarios en debates, propuestas y otros comentarios
Milestone
Hitos en propuestas, proyectos de gasto y procesos
Geozone
Geozonas (distritos)
ProposalNotification
Notificaciones asociadas a propuestas
Tag
Tags en debates y propuestas
Vote
Información sobre votos
Respuesta:
Respuesta:
Actualmente el número máximo (y por defecto) de elementos que se devuelven en cada página está establecido a 25. Para poder navegar por las distintas páginas, es necesario solicitar además información relativa al endCursor
:
La respuesta:
Para recuperar la siguiente página, hay que pasar como parámetro el cursor recibido en la petición anterior, y así sucesivamente:
Esta consulta solicita información relativa a varios modelos distintos en una única petición: Proposal
, User
, Geozone
y Comment
:
Permitir que un cliente personalice las consultas supone un factor de riesgo importante. Si se permitiesen consultas demasiado complejas, sería posible realizar un ataque DoS contra el servidor.
Existen tres mecanismos principales para evitar este tipo de abusos:
Paginación de resultados
Limitar la profundidad máxima de las consultas
Limitar la cantidad de información que es posible solicitar en una consulta
La profundidad máxima de las consultas está actualmente establecida en 8. Consultas más profundas (como la siguiente), serán rechazadas:
La respuesta obtenida tendrá el siguiente aspecto:
El principal factor de riesgo se da cuando se solicitan varias colecciones de recursos en una misma consulta. El máximo número de colecciones que pueden aparecer en una misma consulta está limitado a 2. La siguiente consulta solicita información de las colecciones users
, debates
y proposals
, así que será rechazada:
La respuesta obtenida tendrá el siguiente aspecto:
No obstante, sí que es posible solicitar información perteneciente a más de dos modelos en una única consulta, siempre y cuando no se intente acceder a la colección completa. Por ejemplo, la siguiente consulta que accede a los modelos User
, Proposal
y Geozone
es válida:
La respuesta:
Este es un ejemplo sencillo de código accediendo a la API de la demo de Consul Democracy:
Y este es un ejemplo un tanto más complejo usando paginación, una vez más accediendo a la API de la demo de Consul Democracy:
La API de Consul Democracy utiliza , en concreto la . Si no estás familiarizado con este tipo de APIs, te recomendamos consultar la .
Siguiendo las , la API de Consul Democracy soporta los siguientes tipos de peticiones:
es una interfaz de navegador para realizar consultas a una API GraphQL, así como una fuente adicional de documentación. Consul Democracy utiliza la gema para acceder a esta interfaz en la ruta /graphiql
; esta es la mejor forma de familiarizarse con una API basada en GraphQL.