Sobre o projeto
O Ultralytics OpenAPI é uma ferramenta que lê especificações OpenAPI (versões 3.0 a 3.2.0) e gera duas saídas a partir de um único contrato: documentação interativa de API e um SDK Python tipado. Ele suporta todas as operações HTTP padrão (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD, TRACE).
A configuração é feita por meio de um arquivo `openapi.config.json`, onde você especifica a fonte (arquivo local ou URL), o nome do pacote gerado, a variável de ambiente da chave de API, o caminho base da documentação e diversos metadados do pacote Python (autores, classificadores, versão, licença, etc.). A ferramenta também suporta a geração opcional de CLI ao incluir um arquivo de código-fonte Python pertencente ao consumidor.
Principais recursos incluem:
- Clientes Python síncronos e assíncronos
- Recursos tipados e respostas TypedDict
- Suporte para upload multipart
- Tentativas automáticas para falhas temporárias
- Erros de API estruturados
- Manipulação de chave de API que permanece na memória do navegador para documentos
- Builds de documentação estática determinísticos
- Personalização de marca (logo, favicon, tokens de gradiente)
- Módulo opcional de provedor de autenticação para descoberta de credenciais personalizadas
Os SDKs gerados têm licença padrão AGPL-3.0, mas podem ser configurados. O projeto é desenvolvido com Bun e uv, e inclui comandos para desenvolvimento, testes e geração. SDKs futuros para TypeScript, Go e Java estão planejados.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.