Simplifier vos fichiers OpenAPI avec OpenAPI Trim

La gestion de gros fichiers OpenAPI peut s'avérer fastidieuse, surtout lorsque vous n'avez besoin que d'une petite partie de l'API pour des tâches spécifiques. C'est là que OpenAPI Trimming s'avère utile. Il s'agit d'un outil léger conçu pour réduire vos fichiers OpenAPI afin d'inclure uniquement les points de terminaison et les objets de transfert de données (DTO) qui vous intéressent.

Comment ça marche ?

Disons que vous travaillez avec un gros fichier OpenAPI, mais que vous n'avez besoin que des points de terminaison liés à l'API Quotes. Vous pouvez facilement extraire uniquement ces points de terminaison et supprimer les DTO non pertinents avec une seule commande :

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

Cette commande :

• -i openapi.yaml : utilisez votre fichier OpenAPI YAML existant comme entrée.
• -p /v1/quotes,/v1/users : conservez uniquement les points de terminaison commençant par /v1/quotes et /v1/users.
• -ec CompanyConfigDto,UpdateCompanyConfigDto : excluez des composants spécifiques, dans ce cas, CompanyConfigDto et UpdateCompanyConfigDto.

La définition d'API découpée sera enregistrée sous openapi-trimmer.yaml.

Validation

Pour garantir l'intégrité de votre fichier OpenAPI découpé, validez-le avec :

swagger-cli validate ./openapi-trimmer.yaml

Cette étape permet de détecter tout problème avant de déployer ou de partager le fichier API réduit.

Installation

Vous pouvez installer OpenAPI Trim directement depuis PyPi :

pip install openapi-trimmer

Pour plus de détails et les dernières mises à jour, visitez la page OpenAPI Trim PyPi.

Dépôt GitHub : OpenAPI Trim sur GitHub.

Options de ligne de commande

L'OpenAPI Trim propose plusieurs options pour personnaliser son fonctionnement :

• -h, --help : afficher les informations d'aide.
• -v, --version : affiche le numéro de version.
• -i INPUT, --input INPUT : spécifiez le fichier YAML d'entrée (obligatoire).
• -o OUTPUT, --output OUTPUT : définit le nom du fichier de sortie (facultatif ; par défaut, il ajoute "-trimmed" au fichier d'entrée).
• -p PREFIXES, --prefixes PREFIXES : répertorie les chemins à conserver dans la sortie (séparés par des virgules).
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS : répertorie les composants à exclure (séparés par des virgules).

Conclusion

OpenAPI Trim est un outil essentiel pour les développeurs cherchant à rationaliser leurs fichiers OpenAPI, les rendant plus gérables et adaptés à des besoins spécifiques. Que vous prépariez la documentation de l'API ou simplifiiez une API pour un usage interne, OpenAPI Trim vous fait gagner du temps et des efforts en vous concentrant uniquement sur ce qui compte le plus pour vous.