README.md

eaux-baignade-noumea

API pour accéder à la qualité des eaux de baignade, via le crawling de www.noumea.nc (http://www.noumea.nc/actualites/qualite-des-eaux-de-baignade-0)

Badges

Pour avoir le badge au format svg du status de la plage :

/plages/{plageId}/badge.svg

Shield Endpoint

Shield endpoint a été implémenté pour une expérience optimale :

https://eaux-baignade-noumea.herokuapp.com/plages/{plageId}/shield

En html :

<a href="https://www.noumea.nc/actualites/qualite-des-eaux-de-baignade-0">
  <img src="https://eaux-baignade-noumea.herokuapp.com/plages/0/badge.svg"/>
</a>

Endpoints

/plages
/plages/{plageId}
/plages/{plageId}/badge.svg
/drapeaux
/drapeaux/{drapeauId}
/metadatas
https://eaux-baignade-noumea.herokuapp.com/plages/{plageId}/shield

Sur Heroku :

https://eaux-baignade-noumea.herokuapp.com/plages
https://eaux-baignade-noumea.herokuapp.com/plages/{plageId}
https://eaux-baignade-noumea.herokuapp.com/plages/badge.svg
https://eaux-baignade-noumea.herokuapp.com/drapeaux
https://eaux-baignade-noumea.herokuapp.com/drapeaux/{drapeauId}
https://eaux-baignade-noumea.herokuapp.com/metadatas
https://eaux-baignade-noumea.herokuapp.com/plages/{plageId}/shield

Docker

A terme, je vais automatiser le buid, démarrer, jusqu'à la release de l'image sur les repos.

Créer l'image :

docker build -t eaux-baignades .

Lister les images :

docker images

Démarrer l'image :

docker run --net=host -p 8080:8080 eaux-baignades

Lister les images qui tournent :

CONTAINER ID        IMAGE               COMMAND               
3b71740fda19        eaux-baignades      "java -jar eaux-baig…"

Installer jq puis :

Ouvrir terminal et tester un endpoint ( jq pour afficher proprement):

curl http://localhost:8080/plages | jq '.' | less

Vous devriez obtenir quelque chose comme ça :

  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  1291    0  1291    0     0    904      0 --:--:--  0:00:01 --:--:--   904
[
  {
    "couleurDrapeau": "BLEU",
    "nomPlage": "PLAGE DE LA POINTE MAGNIN",
    "urlIconeDrapeau": "http://www.noumea.nc/sites/default/files/drapeau-bleu.png",
    "plageId": 0,
    "baignadeMessage": "Enjoy !",
    "couleurDrapeauEnglish": "blue"
  },

Documentation swagger

Bien que minimaliste et très perfectible, la doc swagger : https://eaux-baignade-noumea.herokuapp.com/swagger-ui.html