OhAPI Designer

Un éditeur macOS natif conçu pour les spécifications OpenAPI. Auto-complétion contextuelle, validation en ligne, modèles de snippets et un panneau visuel d'opérations — le tout dans une seule fenêtre.

Fonctionnalités

✏️

Éditeur visuel

Concevez vos endpoints avec un éditeur drag-and-drop.

📄

Export OpenAPI

Exportez vos designs en spécifications OpenAPI 3.0.

🔄

Aperçu en direct

Prévisualisez votre documentation API en temps réel.

Éditeur de code intelligent

Un éditeur de texte complet conçu spécifiquement pour les fichiers de spécification API, avec un rendu par viewport sur un thread en arrière-plan.

Coloration syntaxique — Optimisée pour JSON et YAML avec des couleurs distinctes pour les clés, valeurs et délimiteurs
Guides d'indentation — Lignes verticales qui visualisent la profondeur d'imbrication, avec le guide actif mis en surbrillance
Surbrillance de la ligne active — Un arrière-plan subtil marque la ligne d'édition active
Indentation automatique — Règles adaptées au langage pour JSON et YAML avec insertion automatique des crochets
Tab / Shift+Tab — Indenter ou désindenter des lignes individuelles ou des sélections entières
Mode sombre et clair — S'adapte automatiquement à l'apparence du système macOS

Auto-complétion contextuelle

Appuyez sur Ctrl+Espace pour déclencher les complétions. OhAPI Designer analyse la position de votre curseur dans le schéma OpenAPI et suggère des clés, valeurs et références valides.

Couverture complète des spécifications OpenAPI 3.0 et 3.1
Les clés existantes sont filtrées — seules les clés manquantes sont suggérées
Les correspondances uniques sont insérées directement
Naviguez avec les flèches, acceptez avec Entrée ou Tab, annulez avec Échap

Modèles de snippets

Tapez un mot-clé déclencheur et un aperçu semi-transparent en texte fantôme apparaît en ligne. Appuyez sur Tab pour accepter le snippet, puis naviguez entre les espaces réservés de type Xcode.

Navigation cliquable des $ref

Toutes les valeurs $ref sont stylisées en bleu et soulignées. Cmd+Clic sur une référence pour accéder directement à sa définition.

#/components/schemas/...
#/components/parameters/...
#/components/responses/...
#/components/requestBodies/...
#/components/headers/...

Validation OpenAPI

Cliquez sur le bouton Valider de la barre d'outils pour vérifier votre document par rapport à la spécification OpenAPI. Les erreurs et avertissements apparaissent directement dans l'éditeur.

Soulignements ondulés rouges — Erreurs de validation (champs obligatoires manquants, incompatibilités de types, références invalides)
Soulignements ondulés ambrés — Avertissements
Info-bulles au survol — Affichent le message d'erreur et l'emplacement source
Les décorations persistent lors des modifications et ne disparaissent que lorsque le problème est résolu

Panneau des propriétés

Le côté droit de la fenêtre affiche une vue structurée de toutes les opérations API de votre document.

Tableau des opérations — Chaque endpoint listé avec sa méthode HTTP (badge coloré), son chemin et son résumé
Détails de l'opération — Paramètres, corps de requête, réponses (colorées par famille de statut), serveurs, sécurité et tags
Mises à jour en direct — Se rafraîchit automatiquement lors de l'édition, avec un anti-rebond pour éviter le scintillement
Clic pour naviguer — Cliquez sur une opération pour faire défiler l'éditeur jusqu'à son emplacement source
Les opérations dépréciées apparaissent avec un texte barré

Console

Un panneau de console repliable en bas de la fenêtre enregistre les événements pendant votre session d'édition.

Niveaux de log colorés — Info (bleu), Succès (vert), Avertissement (orange), Erreur (rouge)
Clic pour naviguer — Les entrées de log avec un emplacement source font défiler l'éditeur jusqu'à la ligne concernée
Logs par document — Chaque fichier ouvert possède sa propre console indépendante

Écran d'accueil

Au lancement, un écran d'accueil offre un accès rapide à Nouveau document, Ouvrir un document et aux fichiers récents. Il réapparaît automatiquement lorsque tous les documents sont fermés.

Nouveau document — Ouvre la fenêtre de configuration du nouveau document
Ouvrir un document — Ouvre le sélecteur de fichiers
Documents récents — Accès rapide aux fichiers récemment ouverts

Configuration du nouveau document

Fichier > Nouveau ouvre une fenêtre modale où vous configurez votre nouveau document OpenAPI avant sa création.

Choisissez la version OpenAPI : 3.0 ou 3.1
Choisissez le format : JSON ou YAML
Définissez éventuellement un chemin initial avec des cases à cocher de méthode HTTP

Raccourcis clavier

Raccourci	Action
Cmd+N	Nouveau document
Cmd+O	Ouvrir un document
Cmd+S	Enregistrer
Cmd+Z	Annuler
Cmd+Shift+Z	Rétablir
Ctrl+Espace	Déclencher l'auto-complétion
Tab	Accepter la suggestion fantôme / espace réservé suivant / indenter
Shift+Tab	Espace réservé précédent / désindenter
Escape	Fermer le popup / quitter le mode espace réservé
Option+Entrée	Déclencher la suggestion de snippet
Cmd+Clic	Naviguer vers la cible $ref
Cmd+?	Ouvrir le manuel utilisateur

À qui s'adresse-t-il ?

OhAPI Designer est conçu pour tous ceux qui travaillent avec des spécifications OpenAPI sur macOS.

Développeurs API

Concevez et maintenez des API REST avec des outils contextuels.

Ingénieurs backend

Éditez les contrats API parallèlement à votre code.

Rédacteurs techniques

Documentez les API avec des spécifications précises et validées.

Architectes API

Examinez et structurez visuellement de grands documents OpenAPI.

Compatibilité

Format	Extensions
JSON	.json
YAML	.yaml, .yml

Version OpenAPI	Statut
OpenAPI 3.0	Supporté
OpenAPI 3.1	Supporté

Prérequis	Minimum
Système d'exploitation	macOS 12.0 (Monterey)
Architecture	Intel et Apple Silicon

Vous cherchez une visionneuse ?

OhAPI visualise vos spécifications OpenAPI sous forme de diagrammes en arbre interactifs avec un navigateur d'opérations structuré et une visionneuse de code avec coloration syntaxique.

Contacter le support

Si vous avez des questions, n'hésitez pas à nous contacter.

Quelle est la politique de confidentialité d'OhAPI Designer ?

Nous ne collectons aucune donnée personnelle.