Bibliotecas de cliente da API do DeepL e experiência dos programadores: a retrospetiva do ano

Ainda que o conceito de experiência do programador seja algo de relativamente novo no mundo corporativo, o interesse pela experiência de quem desenvolve software tem vindo a aumentar ao longo da última década. 

O motivo é simples. Os projetos de software modernos podem ser bastante complexos. Por essa razão, tentamos minimizar possíveis dificuldades investindo em ferramentas e recursos para programadores que vão além do produto principal: desde documentação a tutoriais, exemplos de código, comunidades e novos canais de apoio. 

Para uma empresa como a DeepL, que disponibiliza um serviço de API a dezenas de milhares de utilizadores em todo o mundo, a experiência dos programadores tem prioridade absoluta. Por isso gostaríamos de partilhar uma breve retrospetiva do que foi feito nesse sentido ao longo deste ano, bem como apresentar alguns dos planos que temos para o futuro. 

Bibliotecas de cliente da API

As bibliotecas de cliente são um elemento fundamental para garantir uma boa experiência de utilizador aos programadores, uma vez que permitem trabalhar num sistema conhecido e criar código de forma mais fácil e eficiente. 

As bibliotecas de cliente foram dos primeiros projetos de código aberto criados pela DeepL. Este tipo de projeto permite que os utilizadores personalizem as bibliotecas de acordo com as suas preferências e também que nos enviem feedback diretamente.

Lançámos a nossa primeira biblioteca de cliente em linguagem Python em agosto de 2021 e, desde então, lançámos bibliotecas em .NET, Node.js, PHP e Java. Um ano depois, em agosto de 2022, cerca de 7% de todos os pedidos da API (representando milhares de milhões de caracteres traduzidos) foram feitos através de uma das nossas bibliotecas de cliente. Além disso, milhares de utilizadores da API fizeram pelo menos um pedido recorrendo a uma das bibliotecas de cliente.  

No próximo ano, planeamos adicionar pelo menos mais uma biblioteca de cliente em linguagem Go. Ao mesmo tempo, continuaremos a atualizar as bibliotecas de cliente existentes à medida que a nossa API for adquirindo novas funcionalidades.  

Tem comentários ou gostaria de sugerir novas funcionalidades para as nossas bibliotecas de cliente? Crie um pedido (issue) no GitHub através do repositório correspondente e envie a sua mensagem. Além disso, também acompanhamos as publicações com a hashtag #deepl no Stack Overflow.

Especificação OpenAPI

Em junho de 2022, publicámos uma especificação no formato OpenAPI para a API do DeepL. Isto permite que os utilizadores possam gerar bibliotecas de cliente para linguagens de programação ainda não disponíveis no DeepL e o acesso à nossa API em ferramentas como Swagger UI ou Postman. Esta especificação também ajuda a equipa do DeepL a manter a documentação da API atualizada. Recentemente atualizámos a nossa documentação com base na especificação OpenAPI, de forma a continuar a desenvolvê-la no futuro de maneira mais simples e eficaz.  

Entre as melhorias que planeamos implementar nas documentações estão os exemplos de códigos para as bibliotecas de cliente, que vêm complementar os exemplos de cURL e HTTP já existentes. 

Para saber mais sobre nossa especificação OpenAPI no GitHub, clique aqui (conteúdo disponível apenas em inglês).

Exemplos de projetos com a API

Ao longo do último ano, vários utilizadores pediram exemplos de projetos com recurso à API do DeepL, tanto para os integrar nas fases iniciais dos seus próprios projetos como para os utilizar como fonte de inspiração e referência. Foi por essa razão que em agosto publicámos o nosso primeiro exemplo de projeto com a API do DeepL: um script para Google Sheets que permite a tradução do conteúdo das células usando o DeepL. Tal como em outros projetos GitHub, este exemplo é de código aberto com licença do MIT. 

Esperamos que este seja o primeiro de muitos dos exemplos de projetos a partilhar no GitHub, mesmo que ainda estejamos a trabalhar nos próximos passos. Caso tenha comentários ou sugestões, não hesite em criar um pedido (issue) no GitHub.  

O feedback dos nossos utilizadores é, como sempre, muito bem-vindo. Continuamos a trabalhar para aumentar o número de funcionalidades, idiomas e combinações do glossário na API do DeepL. 

Nunca usou a API do DeepL e gostaria de experimentar? Registe-se para traduzir até 500.000 caracteres por mês sem custos.

Resumindo:

1. Lançámos a nossa primeira biblioteca de cliente da API em Python em agosto de 2021 e, desde então, a biblioteca tem sido utilizada por milhares de utilizadores do DeepL API Free e do DeepL API Pro. 
2. Além da versão em Python, lançámos bibliotecas de cliente em .NET, Node.js, PHP e Java, bem como uma especificação OpenAPI. 
3. O nosso objetivo é continuar a trabalhar na experiência do programador através de novas bibliotecas de cliente, melhorar a documentação e publicar outros exemplos de código.