Aperçu du projet

Pikturr est un outil léger conçu pour convertir les spécifications d'API Swagger en diagrammes UML de classes. Cela facilite la compréhension des structures d'API complexes ou les revues de conception. Ce projet repose sur JavaScript et Node.js, en utilisant PlantUML pour générer les graphiques.

Structure des dossiers et explications

Voici la structure de base du projet Pikturr avec une brève description :

.
├── main.js              # Fichier principal gérant la logique de conversion.
├── package.json         # Définit les métadonnées, dépendances et scripts.
├── package-lock.json    # Généré automatiquement pour verrouiller les versions.
├── README.md            # Documentation explicative avec instructions d'utilisation.
└── test                 # Dossier contenant les tests unitaires.
    └── ...

• main.js : Le programme principal qui reçoit l'URL d'une spécification Swagger pour produire le diagramme UML.
• package.json : Fichier fondamental pour les projets Node.js, définissant les dépendances et commandes.
• package-lock.json : Complète package.json pour garantir des versions cohérentes entre environnements.
• README.md : Document clé fournissant une introduction rapide à l'utilisation de Pikturr.
• test : Contient le code des tests pour valider les fonctionnalités du logiciel.

Présentation du fichier d'exécution

Le fichier principal est main.js, qui ne fonctionne pas comme un service traditionnel. L'utilisateur ne lance pas ce fichier directement mais utilise des commandes en ligne de commande, par exemple :

node main.js 'http://petstore.swagger.io/v2/swagger.yaml'

Cette instruction génère un diagramme UML à partir de l'URL spécifiée.

Présentation des fichiers de configuration

Pikturr ne propose pas de fichier de configuration classique. La configuration est principalement gérée via des paramètres en ligne de commande ou des variables d'environnement (comme GRAPHVIZ_DOT). Pour personnaliser le comportement ou étendre les fonctionnalités, il faudrait modifier main.js ou ajouter des options de configuration, mais ce n'est pas une étape indépendante par défaut.

Résumé

La conception de Pikturr privilégie la simpilcité et l'utilité, avec une architecture et une configuration directes. Grâce à la structure et les explications des fichiers, vous pouvez rapidement utiliser Pikturr pour transformer vos spécifications Swagger en diagrammes UML visuels. Pour des personnalisations avancées, il faudra consulter le code source ou contribuer à son amélioration.