La librairie permet de fournir les outils pour accéder à l'API de data.gouv.fr.
Elle est utilisable sur Android à travers la dépendance disponible sur Maven Central.
Kotlin DSL :
implementation("com.baptistecarlier.kotlin.datagouvfr:kotlin-datagouv-client:1.x")
Gradle DSL :
implementation 'com.baptistecarlier.kotlin.datagouvfr:kotlin-datagouv-client:1.x'
Toutes les API sont disponibles mais peut-être avez-vous vu un endpoint est manquant ?
Dans ce cas, vous pouvez ajouter une issue pour demander son ajout, ou soyez génial(e) en faisant une PR.
Certaines API sont dépréciées :
API | Méthode | Chemin | Nom |
---|---|---|---|
site |
GET |
/metrics/{id} |
metrics_for |
L'annotation MissingFieldMapping
indique qu'un le modèle ne correspond pas (encore) exactement au modèle défini par l'API.
- Gradle JDK Java 11
- Android SDK
- Android S (API 31)
Il est nécessaire de fournir une clé d'API pour les opérations en écriture (POST
, PUT
, PATCH
, DELETE
) ou pour l'utilisation des endpoints me
, notifications
. Cette clé d'API est disponible dans votre profil.
Elle peut être fournie lors de l'initialisation du service ou après :
val dgfrService = DgfrService(apiKey = VOTRE_CLE)
// ou
dgfrService.setApiKey(apiKey = VOTRE_CLE)
Les functions d'appel aux endpoint retournent un Flow
d'objet DgfrCallState
.
Vous pouvez accéder aux sources pour savoir comment les gérer dans votre app.
Lib :
Kotlin
Kotlin Coroutines
Kotlinx DateTime
Ktor
App :
Google Material Components
AndroidX Navigation library
AndroidX Paging3
AndroidX DataStore
Hilt
Jetpack Compose
Timber
- Liste des versions sur Maven Central
- Plus d'information sur le fonctionnement de l'API : https://doc.data.gouv.fr/api/intro/
- Documentation de référence de l’API : https://doc.data.gouv.fr/api/reference/
- Sonar du projet