Projet

Général

Profil

Project management #14175

Project management #14174: Rayonnement des web-services

Définir format de description des web-services

Ajouté par Benjamin Dauvergne il y a plus de 7 ans. Mis à jour il y a plus de 2 ans.

Statut:
Fermé
Priorité:
Normal
Assigné à:
Catégorie:
-
Version cible:
-
Début:
30 novembre 2016
Echéance:
31 janvier 2017
% réalisé:

0%

Temps estimé:
Patch proposed:
Non
Planning:
Non
Club:
Non

Historique

#1

Mis à jour par Thomas Noël il y a plus de 7 ans

Avez-vous des choses contre http://json-schema.org/ ? (le projet semble avoir un peu repris...)

#2

Mis à jour par Frédéric Péters il y a environ 7 ans

Avez-vous des choses contre http://json-schema.org/ ? (le projet semble avoir un peu repris...)

Je ne suis pas sûr de voir où vient cette suggestion mais généralement je ne pense pas nécessaire de commencer par une description formelle du format et je trouve qu'on va plus vite en commençant par cas après cas donner en exemple la description qui correspondrait.

Exemple : Passerelle annoncer à Combo qu'un service "factures" est disponible :

{
  "type": "invoices",
  "title": "Factures logiciel famille",
  "base_url": "https://passerelle.example.net/family/test/regie/" 
}

Et ça serait déjà un grand pas. Pour reprendre des notes de l'eocamp :

=> décrire les API de façon "fonctionnelle", ie qualifiée, ie son type :.
  • "cette BASE_URL propose une API compatible «newsletters»".
  • "cette BASE_URL propose une API compatible «factures»"
  • "cette BASE_URL propose une API compatible «datasources»"
  • famille
  • appairage
  • agendas
  • SIG (aka nominatim & référentiels d'adresses)
  • SMS
  • gestion de panier

Ensuite, quand il faudra décrire de manière générique des API pour l'action "appel webservice" de w.c.s., il sera temps de décrire davantage et peut-être qu'un schéma deviendra alors utile. Mais pour le moment, "dictionnaire avec trois clés, type, title, base_url", on peut faire sans.

#3

Mis à jour par Frédéric Péters il y a plus de 2 ans

  • Statut changé de Nouveau à Fermé
  • Planning mis à Non
  • Club mis à Non

Projet général de rayonnement qui ne se passera pas comme ça.

Formats disponibles : Atom PDF