avril 2024

Graphinx

Graphinx

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

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

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, et de catégoriser tous les éléments en 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).

Documentation
github.com
Sur Github
github.com

Time spent

57 heures 15 minutes

réalisé avec

  • CSS
  • HTML
  • TypeScript
  • Svelte
  • TypeScript
  • GraphQL
  • Bun