BT

Diffuser les Connaissances et l'Innovation dans le Développement Logiciel d'Entreprise

Contribuez

Sujets

Sélectionner votre région

Accueil InfoQ Actualités APIs.guru rejoint la liste grandissante des Index d'API

APIs.guru rejoint la liste grandissante des Index d'API

APIs.guru est le dernier acteur dans le domaine de l'indexation de définition, l'organisation et la découverte d'APIs.

L'index open source (licence MIT) entretenu par la communauté comprend actuellement 236 descriptions d'API qui couvrent 6 271 endpoints. APIs.guru vise à devenir le "Wikipedia pour les APIs REST".

APIs.guru entre dans un marché de plus en plus encombré avec d'autres sites d'indexation d'API, qui comprend API Stack, API Commons , APIs.io, AnyAPI et des index plus anciens tels que le Répertoire d'API de ProgrammableWeb. Ces index d'API partagent un objectif commun, explique le blogueur Kin Lane d'APIEvangelist.com :

Les développeurs du monde entier utilisent ces définitions dans leur travail et les fournisseurs d'outillage et de services d'API contemporains les utilisent pour définir la valeur qu'ils apportent. Pour aider le secteur des APIs à atteindre le niveau suivant, nous avons besoin que vous intensifiez et partagiez les définitions d'API que vous détenez avec API Stack, APIs.io ou APIs.guru. Et si vous avez le temps et les compétences, nous pourrions utiliser votre aide pour élaborer de nouvelles définitions d'API pour les services populaires disponibles aujourd'hui.

Le contenu d'APIs.guru est maintenu principalement par son créateur, Ivan Goncharov. Selon une entrée du blog de DataFire, le contenu initial a été peuplé "en utilisant une combinaison de récupération automatisée et d'action humaine pour tirer du web les définitions d'API lisibles par la machine".

Les soumissions sont ensuite traitées avec les critères d'évaluation suivants :

  • Filtrer les API privées et non fiables.
  • Convertir les différents formats en OpenAPI (anciennement Swagger) 2.0.
  • Corriger les erreurs, environ 80% des specs en comportent.
  • Ajouter des données supplémentaires, comme : le logo, une catégorie, etc.
  • Mettre à jour les specs sur une base quotidienne.

L'index lui-même est disponible sous forme de fichier JSON unique hébergé via une page GitHub à https://api.apis.guru/v2/list.json>.

Le fichier contient un unique objet JSON avec les IDs de l'API comme clé dans le format : <provider>[:<service>]. Le contenu de chaque description d'API comprend la date d'ajout de la description, la version de l'API préférée actuelle et des liens vers OpenAPI (anciennement connu sous le nom de Swagger) documentation pour le service. Il existe également une forme relativement libre d'objet info qui contient le titre et la description des informations de base, ainsi que des clés x-* pour diverses informations relatives au fournisseur.

L'API Add qui ouvre un ticket sur le dépôt Github d'APIs-guru/api-models permet des ajouts à l'index. Une fois ajoutée, la définition de la spécification d'API référencée sera convertie du format original (RAML, API Blueprint , WADL , etc) au format OpenAPI 2.0. Enfin, un script est exécuté quotidiennement pour surveiller les mises à jour mineures de la définition originale de l'API.

Evaluer cet article

Pertinence
Style

Contenu Éducatif

BT