Cette API à pour but de rendre accessible en lecture l'intégralité des médicaments vétérinaires autorisés en France.
Elle s'appuie sur un couple de deux fichiers XML fournis par la plateforme [https://data.gouv.fr/].
La valeur des données n’est pas transformée. Seules les clés le sont pour en exposer la version anglophone.
La correspondance de ces clés anglophones est décrite dans la spécification Open API 3.0 fourni avec l'API.
La documentation est disponible ici : [https://vets-doxwjojdmq-od.a.run.app]
Warning Cette API n'a pas d'authentification est autorise les CORS sur toutes les origines. Si toutefois elle commence à en être abusée, je me réserve le droit d'ajouter une authentification, voire même de couper l'accès au service.
- Notice d'utilisation des données
- Base de données des médicaments vétérinaires autorisés en France (XML)
- Données de Référence (XML)
Le fonctionnement est découpé en 3 étapes :
- Un script permettant d'ingérer les fichiers au format XML pour les transformer en un JSON pour faciliter l'ingestion des données dans une base de données
- Un script permettant de faire l'ingestion des données JSON dans une base de données
- Une API qui expose les données
L'API est d'abord mis en container via Docker puis publié sur une registry privée sur la plateforme Google Cloud : Google Cloud Artifacts.
Cette image Docker est ensuite déployée dans un environnement serverless de Google Cloud : Google Cloud Run.
La base de données au format SQLite est directement commité et embarqué dans l'image Docker ce qui permet de ne pas avoir à maintenir de base de données à côté. Tout est "self-contained" dans une image Docker.
Dans la mesure où la base de données et l'API ne sont qu'en lecture seule, cela ne pose pas de problème pour l'objectif qu'à cette API.
Voici dans les grandes lignes les instructions pour faire tourner l'API vous-même :
$ git clone ...
$ pnpm install
$ pnpm prisma db push
$ pnpm prisma generate
$ pnpm ingest
$ pnpm seed$ pnpm dev$ pnpm start$ docker build -t vets .
$ docker run -p 8080:8080 vets- typescript - Le langage utilisé
- fastify - Le serveur derrière l'API
- https://www.npmjs.com/package/tsx - L'outil permettant de faire tourner le serveur (en dev comme en prod)
- prisma - Toute la partie interface base de données
- sqlite - Le moteur de base de données
- prettier - Outil de formatage de code
- docker - Outil de container pour le déploiement
- fast-xml-parser - Librairie pour transformer le XML en JSON
- pnpm - Le package manager
- redoc et Open API - Génération de la documentation