ApiNewYear

ZIA API 2017 - Epitech

View project on GitHub

Qu'est-ce que ApiNewYear ?

ApiNewYear est une API proposée aux étudiants d’Epitech de troisième année travaillant sur le projet Zia.

Elle s'articule autour de trois axes :

  • Modules : l'architecture du Zia doit être modulaire
  • Chaîne d'exécution : elle gère le flux d'exécution des modules en fonction de leur priorité
  • Protocole HTTP : les communications client / serveur doivent respecter ce protocole

Pourquoi utiliser et voter pour ApiNewYear ?

  • Répond à vos problèmes : elle a été pensée pour supporter l’architecture modulaire du projet (gestion des priorités, chargement dynamique, etc.) tout en vous proposant un modèle stable pour gérer les communications client / serveur en respectant le protocole HTTP
  • Simple d’utilisation : si vous ne souhaitez pas passer un mois à savoir comment marche une API, ne cherchez pas plus loin. Elle a été conçue avant tout selon trois critères : utilisable, intuitive et flexible
  • Sûre : notre API a été mûrement réfléchie, testée et re-testée donc vous n’aurez pas de surprises. L’objectif premier reste de vous fournir une API qui soit utilisable et qui ait du sens !
  • Documentée : vous ne vous arracherez pas les cheveux à savoir qui fait quoi, tout est bien expliqué dans la documentation. Vous trouverez également un exemple d’implémentation ainsi qu'une FAQ
  • Un support est là pour vous : nous nous engageons à être disponible pour vous si vous rencontrez des problèmes lors de l’utilisation de l’API. Des membres de notre groupe sont prévus pour suivre et répondre à vos demandes donc n’hésitez-pas à nous contacter

Comment fonctionne l'API ?

Si vous souhaitez en savoir davantage quant au fonctionnement de l'API, nous vous conseillons de commencer par lire la FAQ, puis de prendre connaissance de l'UML et, pour finir, éventuellement scanner la documentation.

Quels sont les étudiants à l'origine de cette API ?

Nous sommes tous des étudiants de Epitech Nantes :

  • Kevin Almansa (almans_k)
  • Kevin Labbe (labbe_k)
  • Roger Lewis (lewis_r)
  • Hector Gutierrez (gutier_h)
  • Christophe Marchand (marcha_s)
  • Adrien Domoison (domois_a)

Comment nous contacter ?

Pour tout problème technique, merci de bien vouloir créer un ticket.

Si vous pensez que ce n’est pas adapté à votre demande, n’hésitez-pas à nous contacter par mail : zia.apinewyear@gmail.com. Il sera ainsi relayé à tous les membres de notre équipe.