Graphinx

Une bibliothèque pour générer des sites de documentation beaux et interactifs pour les API GraphQL. Initialement créé pour Churros

L’idée de Graphinx est de maintenir l’API à jour en utilisant le code source du serveur API autant que possible, aux côtés des descriptions GraphQL.

Tous les éléments sont catégorisés dans des modules, car les gros API GraphQL qui ont des sites de documentation générés automatiquement ont tendance à être des pages uniques, difficiles à naviguer, qui contiennent tout les types, triés par ordre alphabétique, ce qui n’est pas idéal (voir par exemple, la documentation de l’API GraphQL de Github).

Le nom vient d’un mot-valise de GraphQL et de Sphinx, un générateur de site de documentation populaire pour les bibliothèques Python

Utilisation de Graphinx pour la documentation de l'API de Churros
La fonctionnalité 'Try it live'

réalisé avec