OpenAPI DevTools - une extension Chrome qui génère automatiquement des spécifications d’API

 (github.com/AndrewWalsh)
3 points par GN⁺ 2023-10-26 | 1 commentaires | Partager sur WhatsApp
  • Génération en temps réel de spécifications OpenAPI à partir des requêtes réseau d’une page web
  • Ajoute un nouvel onglet intitulé OpenAPI dans les Chrome DevTools
    • Génération instantanée d’une spécification OpenAPI 3.1 pour un site web ou une application
    • Fusion automatique, pour chaque endpoint, des nouveaux en-têtes de requête et de réponse, des corps et des paramètres de requête
    • En cliquant sur un paramètre de chemin, fusion des requêtes existantes et futures correspondantes
    • Possibilité d’afficher la spécification dans l’outil avec Redocly et de la télécharger en un clic
  • L’extension remplit automatiquement la spécification à partir des requêtes JSON générées pendant la navigation sur le web
  • Le menu de configuration permet de filtrer les hôtes et de paramétrer les chemins des URL
  • Même si le même endpoint renvoie des données différentes, l’extension inclut toutes les informations dans la spécification finale
  • Le processus de fusion des requêtes n’est pas réversible, mais l’utilisateur peut effacer la spécification et recommencer à tout moment

À lire aussi

1 commentaires

 
GN⁺ 2023-10-26
Avis Hacker News
  • L’extension Chrome OpenAPI DevTools est reconnue pour sa capacité à générer des spécifications d’API.
  • Les utilisateurs la trouvent utile pour écrire du code dans la console JavaScript, ce qui permet d’exécuter rapidement des tâches complexes.
  • Parmi les suggestions pour cet outil, l’une consiste à documenter les en-têtes d’authentification et à stocker les valeurs des jetons afin de faciliter l’utilisation de l’API.
  • Une demande de fonctionnalité a été formulée pour générer des snippets boilerplate Python via un bouton « Copier en requête Python ».
  • L’outil est comparé à des outils similaires comme vite-plugin-web-extension et mitmproxy2swagger, avec un accent mis sur la grande praticité de l’extension de navigateur.
  • L’outil a été salué pour sa capacité à décoder les API de sites web, ce qui peut être une tâche délicate.
  • Des questions ont été soulevées sur sa capacité à gérer les valeurs optionnelles et à marquer les champs de type chaîne comme des « énumérations ».
  • L’outil peut être vu comme allant dans le sens d’une transformation de l’ensemble du web en API, malgré les obstacles liés à la connexion et à l’inscription.
  • Plusieurs suggestions de fonctionnalités ont été avancées, comme le filtrage des propriétés de réponse, le travail avec des données non JSON, le recoupement avec des API publiquement documentées et des noms d’hôte, le stockage local des identifiants utilisateur, ainsi que la génération de clients à partir des spécifications OpenAPI.