OpenAPI / Swagger Formatter

Format and validate OpenAPI / Swagger specs (JSON or YAML) and count paths and operations.

C'est un outil local : il s'exécute entièrement dans votre navigateur. La spec OpenAPI ou Swagger que vous collez ne quitte jamais votre appareil — rien n'est téléversé vers ArrayKit ni vers aucun serveur.

Convertir entre YAML et JSON

À propos de OpenAPI / Swagger Formatter

Le formateur OpenAPI d'ArrayKit embellit et valide les spécifications OpenAPI et Swagger en JSON ou YAML, le tout dans votre navigateur. Collez une spec et il analyse le document, signale la version détectée (OpenAPI 3.x ou Swagger 2.0), le titre de l'API, et compte combien de chemins et d'opérations elle définit, puis réémet du JSON ou YAML propre et indenté de manière cohérente. Il est conçu pour les développeurs backend et API, les rédacteurs techniques et les équipes de plateforme qui ont besoin d'un moyen rapide de nettoyer un contrat édité à la main, de convertir entre JSON et YAML, ou de vérifier une spec avant de la committer ou de l'envoyer à Swagger UI, à des générateurs de code ou à une passerelle. Comme la construction de la requête et l'analyse se font localement, vous pouvez formater des définitions d'API internes ou non publiées sans les envoyer à un serveur. Utilisez-le pour détecter du YAML mal formé, confirmer le nombre d'opérations et standardiser le formatage dans un dépôt.

Fonctionnalités

Comment utiliser OpenAPI / Swagger Formatter

  1. Collez votre spec OpenAPI ou Swagger (JSON ou YAML) dans le panneau de saisie
  2. Choisissez le format de sortie avec le bouton JSON / YAML de la barre d'outils
  3. Lisez la bannière de résumé pour la version, le titre, le nombre de chemins et le nombre d'opérations
  4. Copiez la spec formatée ou téléchargez-la sous forme de openapi.json ou openapi.yaml

Exemple

Entrée

openapi: 3.0.3
info: { title: Example API, version: 1.0.0 }
paths:
  /users:
    get: { summary: List users, responses: { '200': { description: OK } } }
    post: { summary: Create user, responses: { '201': { description: Created } } }

Sortie

openapi: 3.0.3
info:
  title: Example API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: OK
    post:
      summary: Create user
      responses:
        '201':
          description: Created

Une spec OpenAPI 3.0 minimale — le formateur indique « OpenAPI 3.0.3 · Example API · 1 chemin · 2 opérations ».

Erreurs courantes et dépannage

Foire aux questions

Qu'est-ce qu'un formateur OpenAPI / Swagger ?
C'est un outil qui analyse une spécification d'API OpenAPI 3.x ou Swagger 2.0 et la réémet en JSON ou YAML propre et indenté de manière cohérente, tout en signalant la version et le nombre de chemins et d'opérations afin que vous puissiez rapidement relire et standardiser une spec.
Prend-il en charge à la fois les specs JSON et YAML ?
Oui. Comme le JSON est lui-même du YAML valide, vous pouvez coller l'un ou l'autre format. Utilisez le bouton JSON / YAML pour choisir comment la sortie formatée est émise, ce qui vous permet aussi de convertir une spec d'un format à l'autre.
Valide-t-il entièrement ma spec par rapport au schéma OpenAPI ?
Il valide que le document s'analyse comme du JSON ou du YAML bien formé et détecte la version, le titre, les chemins et les opérations. Il n'exécute pas une validation JSON Schema complète de chaque champ, il ne signalera donc pas une propriété requise manquante au fond d'une opération.
Quelles versions reconnaît-il ?
Il étiquette OpenAPI 3.x via le champ openapi et Swagger 2.0 via le champ swagger. Tout document sans l'un de ces champs est formaté mais marqué comme version inconnue.
Ma spec d'API est-elle téléversée quelque part ?
Non. L'analyse, la validation et le formatage s'exécutent entièrement dans votre navigateur. La spec que vous collez ne quitte jamais votre appareil et rien n'est téléversé vers ArrayKit, donc les contrats d'API internes ou non publiés restent privés.
Puis-je télécharger le résultat formaté ?
Oui. La spec formatée peut être copiée ou téléchargée sous forme de openapi.json ou openapi.yaml selon le format de sortie que vous avez sélectionné.

Outils associés

Tous les outils ArrayKit