openapi

Ultralytics OpenAPI 是一个工具，它读取 OpenAPI 规范（3.0 至 3.2.0 版本），并从单一契约生成两种输出：交互式 API 文档和类型化 Python SDK。它支持所有标准 HTTP 操作（GET、POST、PUT、PATCH、DELETE、OPTIONS、HEAD、TRACE）。 配置通过 `openapi.config.json` 文件完成，您可以在其中指定源（本地文件或 URL）、生成的包名、API 密钥环境变量、文档基础路径以及各种 Python 包元数据（作者、分类器、版本、许可证等）。该工具还支持通过包含消费者拥有的 Python 源文件来生成可选的 CLI。 主要功能包括： - 同步和异步 Python 客户端 - 类型化资源和 TypedDict 响应 - 多部分上传支持 - 临时故障自动重试 - 结构化 API 错误 - API 密钥处理（在文档中保留在浏览器内存中） - 确定性静态文档构建 - 可自定义品牌（徽标、网站图标、渐变令牌） - 可选的身份验证提供程序模块，用于自定义凭据发现 生成的 SDK 默认使用 AGPL-3.0 许可证，但可以配置。该项目使用 Bun 和 uv 开发，并包含用于开发、测试和生成的命令。未来计划支持 TypeScript、Go 和 Java 的 SDK。