Commit ef7daffa authored by Blaise de Carné 's avatar Blaise de Carné

update doc

parent 3dbf5964
......@@ -43,7 +43,8 @@
},
"scripts": {
"clean": "vendor/bin/php-cs-fixer fix -v --using-cache=no",
"generate_doc": [
"doc-serve": "docsify serve docs",
"doc-generate": [
"graphql-markdown http://localhost:8080 > docs/api/reference.md",
"sed -i -e \"s/# Schema Types/# Référence/g\" docs/api/reference.md",
"sed -i -e \"s/href=\\\"#/href=\\\"#\\/api/reference?id=/g\" docs/api/reference.md",
......
......@@ -25,7 +25,8 @@ Voici la liste des arguments disponibles :
],
sort: [
# ... <- Liste des règles de tri des résultats
]
],
lang: "fr"
) {
# ...
}
......@@ -264,4 +265,10 @@ Cette requête extrait tous les identifiants des **POI** par ordre décroissant
}
}
}
```
\ No newline at end of file
```
## lang
**lang** permet de limiter les propriétés traduisibles renvoyées dans la réponse aux
seules valeurs de la langue sélectionnée. La liste des codes acceptés est définie par
la norme **ISO 639-1** : [https://fr.wikipedia.org/wiki/Liste_des_codes_ISO_639-1].
# Champs
## Généralités
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 :
......@@ -36,7 +38,6 @@ pour connaître la liste des champs d'un POI : [PointOfInterest](api/reference.m
la spécification GraphQL n'autorisant pas cette notation, l'API DATAtourisme remplace le double point par un `_`.
Exemple: `rdfs:label` devient `rdfs_label`.
** Exemple **
```graphql
......@@ -45,9 +46,12 @@ Exemple: `rdfs:label` devient `rdfs_label`.
total
results {
_uri # <- Identifiant du POI
rdfs_label # <- Nom du POI
hasDescription {
shortDescription # <- Description du POI
dc_identifier # <- Référence du POI
isLocatedAt {
schema_geo {
schema_latitude # <- Latitude du POI
schema_longitude # <- Longitude du POI
}
}
}
}
......@@ -64,29 +68,44 @@ Exemple: `rdfs:label` devient `rdfs_label`.
"results": [
{
"_uri": "https://data.datatourisme.gouv.fr/21/5430055a-2d35-3ce7-adc9-ebecb9f5cbfd",
"rdfs_label": ["Jouer aux échecs"],
"hasDescription": [{
"shortDescription": [
"Rendez-vous le 1er et le 3ème vendredi du mois à la maison des Associations, cours apprentissage, perfectionnement, rencontres amicales, tournois."
"dc_identifier": ["FMACHA0100957599"],
"isLocatedAt": [{
"schema_geo": [{
"schema_latitude": [
49.376388888889
],
"schema_longitude": [
6.1580555555556
]
}]
}]
},
{
"_uri": "https://data.datatourisme.gouv.fr/21/ce824246-dd4f-3f08-ab90-974a409f67d6",
"rdfs_label": ["Le sens de la fête"],
"hasDescription": [{
"shortDescription": [
"Comédie de Eric Toledano et Olivier Nakache. Avec Jean-Pierre Bacri, Gilles Lellouche, Eye Haidara."
"dc_identifier": ["FMACHA0100957578"],
"isLocatedAt": [{
"schema_geo": [{
"schema_latitude": [
48.693055555556
],
"schema_longitude": [
6.1794444444445
]
}
]},
}]
}]
},
{
"_uri": "https://data.datatourisme.gouv.fr/31/00024f0a-74b7-34fd-80f0-eec5cbf61189",
"rdfs_label": ["Randonnée"],
"hasDescription": [{
"shortDescription": [
"Randonnée par les Randonneurs du Montet"
"dc_identifier": ["FMACHA0100705801"],
"isLocatedAt": [{
"schema_geo": [{
"schema_latitude": [
49.360329728326
],
"schema_longitude": [
6.1624977836914
]
}]
}]
}
]
......@@ -95,3 +114,54 @@ Exemple: `rdfs:label` devient `rdfs_label`.
}
```
## Propriétés multilingues
Certaines propriétés (rdf:label, :shortDescription) sont multilingues : chaque valeur peut se retrouver traduite
en plusieurs langues.
Dans ce cas précis, leur structure est décomposée afin de connaître la langue associée à chacune des valeurs :
** Exemple **
```graphql
{
poi {
total
results {
_uri
rdfs_label {
value
lang
}
}
}
}
```
** Résultat **
```json
{
"data": {
"poi": {
"total": 1308,
"results": [
{
"_uri": "https://data.datatourisme.gouv.fr/21/5430055a-2d35-3ce7-adc9-ebecb9f5cbfd",
"rdfs_label": [
{ "value": "Jouer aux échecs", lang: "fr" },
{ "value": "Play chess", lang: "en" }
]
},
{
"_uri": "https://data.datatourisme.gouv.fr/21/ce824246-dd4f-3f08-ab90-974a409f67d6",
"rdfs_label": [
{ "value": "Randonnée", lang: "fr" },
{ "value": "Hiking", lang: "en" }
]
}
]
}
}
}
```
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