À propos du projet
Ultralytics OpenAPI est un outil qui lit les spécifications OpenAPI (versions 3.0 à 3.2.0) et génère deux sorties à partir d'un seul contrat : une documentation API interactive et un SDK Python typé. Il prend en charge toutes les opérations HTTP standard (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE).
La configuration se fait via un fichier `openapi.config.json`, où vous spécifiez la source (fichier local ou URL), le nom du package généré, la variable d'environnement de la clé API, le chemin de base de la documentation, et diverses métadonnées de package Python (auteurs, classificateurs, version, licence, etc.). L'outil prend également en charge la génération optionnelle de CLI en incluant un fichier source Python appartenant au consommateur.
Les fonctionnalités clés incluent :
- Clients Python synchrones et asynchrones
- Ressources typées et réponses TypedDict
- Prise en charge du téléchargement multipart
- Nouvelles tentatives automatiques pour les échecs temporaires
- Erreurs API structurées
- Gestion de la clé API qui reste dans la mémoire du navigateur pour les docs
- Constructions de documentation statique déterministes
- Personnalisation de la marque (logo, favicon, jetons de dégradé)
- Module optionnel de fournisseur d'authentification pour la découverte personnalisée des identifiants
Les SDK générés sont par défaut sous licence AGPL-3.0 mais peuvent être configurés. Le projet est développé avec Bun et uv, et inclut des commandes pour le développement, les tests et la génération. Des SDK futurs pour TypeScript, Go et Java sont prévus.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.