Si vous travaillez avec OpenAPI depuis un certain temps, il est probable que vous ayez utilisé Redocly CLI.

C'est l'un de ces outils qui s'intègre discrètement à votre flux de travail quotidien. Besoin de lint une spécification API ?peluches redoclyavez-vous couvert. Besoin de regrouper une spécification multi-fichiers avant le déploiement ?regrouper redoclyfait le travail. Vous souhaitez générer une documentation API attrayante ? Une seule commande vous y amène.

Pour de nombreux développeurs, c'est tout ce dont ils ont besoin.

Mais le développement des API a évolué. Les équipes modernes ne se contentent plus d'écrire des fichiers OpenAPI, elles conçoivent des API de manière collaborative, créent des serveurs fictifs avant que le backend n'existe, exécutent des tests d'API automatisés dans des pipelines CI/CD et partagent de la documentation entre plusieurs équipes.

C'est alors qu'une question se pose naturellement :

Est-ce que Redocly CLI est encore suffisant, ou est-il temps de passer à autre chose ?

La réponse dépend moins de l'outil qui possède la liste de fonctionnalités la plus longue que de la manière dont votre équipe crée réellement les API.

Dans cet article, nous examinerons ce que Redocly CLI fait exceptionnellement bien, où il commence à montrer ses limites et quelles alternatives ont du sens en fonction de votre flux de travail.

@redocly/cli

Ce que Redocly CLI obtient correctement

Une chose pour laquelle Redocly mérite le mérite est qu'il n'essaye pas de tout faire.

Au lieu de cela, il se concentre sur une poignée de tâches essentielles et les exécute extrêmement bien.

Pour la plupart des développeurs, ces tâches sont :

• Spécifications Linting OpenAPI
• Regroupement de spécifications multi-fichiers
• Diviser les spécifications en fichiers réutilisables
• Documentation du bâtiment
• Appliquer les règles de conception des API

La commande la plus populaire est probablement :

Contrairement à la simple validation de schéma, le linter de Redocly peut appliquer des guides de style personnalisés dans une organisation.

Cela signifie que vous pouvez vous assurer que chaque API respecte les conventions de dénomination, les normes de réponse, les exigences de sécurité et d'autres règles de gouvernance avant q...
[Courte citation de 8% de l'article original]