Клиентские библиотеки DeepL API и developer experience. Обзор за год

Developer experience, или пользовательский опыт разработчиков, – относительно новое понятие в корпоративном лексиконе, однако в последние годы интерес к нему стабильно растет. 

Это закономерно, ведь современные проекты по разработке программного обеспечения бывают крайне сложными. Чтобы облегчить процесс разработки, компаниям необходимо инвестировать в развитие не только основного продукта, но и дополнительных ресурсов и инструментов для разработчиков: например, документации, обучающих материалов и примеров кода, а также каналов поддержки и общения с другими специалистами. 

С API от DeepL работают уже десятки тысяч пользователей по всему миру, и для нас крайне важно обеспечить разработчикам положительный пользовательский опыт. В этой публикации мы хотим рассказать о том, какие шаги по достижению этой цели мы предприняли за прошедший год, а также о наших планах на будущее. 

Клиентские библиотеки API

Клиентские библиотеки играют ключевую роль в нашей работе по улучшению пользовательского опыта разработчиков: они дают пользователям возможность работать в знакомой им экосистеме и писать более простой и эффективный код. 

Клиентские библиотеки стали первой группой проектов с открытым исходным кодом от DeepL. Благодаря тому, что в основе наших библиотек лежит открытый код, пользователям проще настраивать их в соответствии со своими потребностями, а также напрямую делиться с нами отзывами.

В августе 2021 года мы выпустили первую клиентскую библиотеку для Python, после чего мы также добавили библиотеки для .NET, Node.js, PHP и Java. Спустя год, в августе 2022 года, уже около 7% от общего количества запросов к DeepL API (объемом в миллиарды символов) приходилось на запросы, сделанные с помощью одной из наших клиентских библиотек – несколько тысяч пользователей API отправили хотя бы один запрос таким образом.  

В следующем году мы планируем добавить еще как минимум одну клиентскую библиотеку: для языка Go. Мы также продолжим обновлять существующие клиентские библиотеки по мере добавления поддержки новых функций в наш API.  

У вас есть предложения по развитию клиентских библиотек или вы хотели бы поделиться с нами обратной связью? Просто создайте запрос в трекере GitHub Issues в соответствующем репозитории. Мы также следим за публикациями по хэштегу #deepl на Stack Overflow!

Спецификация OpenAPI

В июне 2022 года мы опубликовали спецификацию OpenAPI для DeepL API. С появлением этой спецификации пользователям стало проще создавать клиентские библиотеки для языков программирования, которые пока не поддерживаются DeepL, а также работать с API через Swagger UI или Postman. Благодаря этой спецификации команде DeepL также будет легче поддерживать документацию в актуальном состоянии, ведя ее последовательно и эффективно. Недавно мы переработали нашу документацию с учетом спецификации OpenAPI, благодаря чему документацию будет проще совершенствовать в будущем.  

В частности, мы планируем дополнить существующие примеры cURL- и HTTP-запросов примерами кода для клиентских библиотек. 

Спецификация OpenAPI доступна на GitHub по этой ссылке.

Примеры проектов с использованием API от DeepL

В этом году многие пользователи просили нас опубликовать образцы кода, которые можно было бы использовать в качестве отправной точки при работе над новыми проектами или в качестве примера при интеграции API от DeepL. В августе 2022 года мы опубликовали наш первый пример проекта с использованием DeepL API — скрипт для Google Таблиц для перевода текстов, содержащихся в ячейках таблиц, с помощью DeepL. Как и прочие наши проекты на GitHub, это проект с открытым исходным кодом, распространяемым на условиях лицензии MIT. 

Хотя мы еще не определили окончательный план работы над подобными проектами, мы надеемся, что за этим примером последуют многие другие и мы продолжим публиковать новые проекты на GitHub. Если у вас есть особые пожелания или предложения, вы можете поделиться ими с нами через тикет в соответствующем репозитории!  

Мы также будем рады получить ваши отзывы о нашей работе по улучшению пользовательского опыта разработчиков. Мы планируем и далее разрабатывать новые функции для API, а также работать над обеспечением поддержки новых языков в DeepL Переводчике и новых языковых комбинаций для функции глоссария. 

Вы еще не пользовались DeepL API, но готовы попробовать? Зарегистрируйтесь по этой ссылке и получите возможность переводить до 500 000 символов в месяц бесплатно.

Вкратце:

  1. Мы выпустили первую клиентскую библиотеку DeepL API для Python год назад, в августе 2021 года, и с тех пор библиотекой воспользовались уже тысячи пользователей DeepL API Free и Pro. 

  2. Мы также опубликовали клиентские библиотеки для .NET, Node.js, PHP и Java и спецификацию OpenAPI. 

  3. Мы планируем и далее работать над улучшением пользовательского опыта разработчиков: развивать наши клиентские библиотеки, улучшать документацию и публиковать новые примеры кода.