Commit 8cfdd16b authored by Blaise de Carné 's avatar Blaise de Carné

typo

parent f49f0c52
Pipeline #49249 passed with stage
in 18 seconds
......@@ -32,12 +32,12 @@ Voici la liste des arguments disponibles :
}
```
?> L'ordre des arguments n'a pas d'importance.
?> **Note** : L'ordre des arguments n'a pas d'importance.
## uri
L'argument **uri** permet de requêter un POI en particulier, en précisant son URI. Le POI en question sera alors renvoyé
par l'API en respectant la structure des champs demandée dans le corps de la requête.
L'argument **uri** permet de demander un POI en particulier, en précisant son URI. Le POI en question sera alors renvoyé
par l'API en respectant la structure des champs demandés dans le corps de la requête.
** Exemple **
......@@ -54,7 +54,7 @@ par l'API en respectant la structure des champs demandée dans le corps de la re
}
```
Cette requête extrait tous les identifiants des **POI** dont l'uri vaut "https://data.datatourisme.gouv.fr/31/27684064-5142-3a1f-ac20-9c1b656732c7".
Cette requête extrait tous les identifiants des **POI** dont l'URI est "https://data.datatourisme.gouv.fr/31/27684064-5142-3a1f-ac20-9c1b656732c7".
** Résultat **
......@@ -107,6 +107,7 @@ Les arguments **limit** et **from** permettent de gérer la pagination de la req
}
}
```
Cette requête extrait `2` identifiants de **POI** à partir du `cinquième` résultat renvoyé par la requête.
** Résultat **
......@@ -135,7 +136,6 @@ Cette requête extrait `2` identifiants de **POI** à partir du `cinquième` ré
## filters
L'argument **filters** permet de préciser une liste des filtres permettant de limiter le résultat en fonction des critères.
Les filtres permettent de limiter les résultats en fonction de critères.
** Exemple **
......@@ -164,7 +164,8 @@ Le fonctionnement et la liste des filtres sont détaillés sur [la page dédiée
## sort
**sort** permet de trier les résultats en fonction d'une ou plusieurs propriété.
**sort** permet de trier les résultats en fonction d'une ou plusieurs propriétés.
```graphql
{
poi(
......@@ -177,8 +178,9 @@ Le fonctionnement et la liste des filtres sont détaillés sur [la page dédiée
}
}
```
L'**ordre de tri** peut être '**desc**' ou '**asc**'.
Par défaut, l'ordre est aléatoire.
L'**ordre de tri** peut être '**desc**' ou '**asc**'. Par défaut, l'ordre est aléatoire.
```graphql
{
poi(
......@@ -191,7 +193,9 @@ Par défaut, l'ordre est aléatoire.
}
}
```
Les propriétés peuvent être atteintes en intégrant la hiérarchie dans le tri
```graphql
{
poi(
......@@ -204,7 +208,9 @@ Les propriétés peuvent être atteintes en intégrant la hiérarchie dans le tr
}
}
```
Les tris peuvent être cumulés simplement :
```graphql
{
poi(
......@@ -234,6 +240,7 @@ Les tris peuvent être cumulés simplement :
}
}
```
Cette requête extrait tous les identifiants des **POI** par ordre décroissant du nombre de personnes autorisés.
** Résultat **
......
# Champs
Le principe essentiel de GraphQL est d'adapter la réponse aux champs demandé par l'utilisateur dans le corps de la
Le principe essentiel de GraphQL est d'adapter la réponse aux champs demandés par l'utilisateur dans le corps de la
requête :
```graphql
......@@ -25,12 +25,12 @@ Voici la liste des champs disponibles :
}
```
C'est dans le champs **results** que l'utilisateur décrit précisément la structure des POI qu'il souhaites récupérer.
C'est dans le champs **results** que l'utilisateur décrit précisément la structure des POI qu'il souhaite récupérer.
Cette structure doit respecter le format de l'ontologie.
L'[introspection GraphQL](http://graphql.org/learn/introspection/) vous permet de connaître précisément les champs et
sous-champs disponibles. Vous pouvez également consulter la [référence GraphQL](api/reference.md) de l'API, notemment
pour connaître la liste des champs d'un POI : <a href="#/guide/schema?id=pointofinterest">PointOfInterest</a>.
pour connaître la liste des champs d'un POI : [PointOfInterest](api/reference.md#pointofinterest).
?> **Note sur les namespaces RDF :** Les conventions RDF imposent le `:` entre le prefix du namespace et sa propriété,
le langage GraphQL ne permettant pas cette notation, l'API DATAtourisme le remplace par un `_`.
......
# Filtres
Datatourisme permet de filtrer les résultat en utilisant des fonctions telles que `gt` *(plus grand que)*
ou `eq` *(égal)*.
DATAtourisme permet de filtrer les résultat en utilisant des fonctions telles que `gt` *(plus grand que)*
ou `eq` *(égal)*.
Dans le but d'être clairement identifiés, tous les filtres sont préfixés par un underscore: `_gte`, `_not`, etc.
Les **filtres** permettent donc de sélectionner des résultats en fonction de critères passés en paramètres.
Les **filtres** permettent donc de sélectionner des résultats en fonction de critères passés en paramètres.
```graphql
{
poi(
......@@ -18,7 +20,9 @@ Les **filtres** permettent donc de sélectionner des résultats en fonction de c
}
}
```
Les propriétés hiérarchiques peuvent être atteintes en intégrant la hiérarchie dans le filtre :
```graphql
{
poi(
......@@ -30,9 +34,11 @@ Les propriétés hiérarchiques peuvent être atteintes en intégrant la hiérar
# ...
}
}
```
Par défaut, l'ensemble des filtres sont cumulatifs : le POI doit répondre à tous les filtres pour être retourné.
L'utilisateur peut utiliser les opérateurs logiques pour modifier ce comportement :
```graphql
{
poi(
......@@ -48,7 +54,9 @@ L'utilisateur peut utiliser les opérateurs logiques pour modifier ce comporteme
}
}
```
Les opérateurs logiques sont cumulatifs hiérarchiquement :
```graphql
{
poi(
......@@ -71,7 +79,8 @@ Les opérateurs logiques sont cumulatifs hiérarchiquement :
}
```
Un filtre peut être de plusieurs formes
Un filtre peut être de plusieurs formes :
```graphql
{
poi(
......
# Point d'accès GraphQL
Afin de permettre à des applicatif tiers de tirer partie de l'API GraphQL (au travers du client
Afin de permettre à des applicatifs tiers de tirer partie de l'API GraphQL (au travers du client
[Apollo](https://www.apollographql.com/client) par exemple), vous devez mettre en place un point d'accès HTTP. Voici
un exemple de code PHP permettant de le faire :
......
# Resolver
Datatourisme API peut s'interfacer avec différentes sources de données.
Par défaut, celle-ci interroge le système de gestion de base de données graphe Blazegraph mais
il est tout à fait possible de configurer Datatourisme API pour interroger des endpoints de type
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment