Clientbibliotheken voor de DeepL API en Developer Experience: een jaaroverzicht

Developer Experience is nog altijd een relatief nieuw begrip in het bedrijfsleven, maar desalniettemin is het interesse voor de gebruikerservaring van softwareontwikkelaars in de afgelopen tien jaar gestaag toegenomen. 

Verwonderlijk is dat niet: moderne softwareprojecten kunnen immers ontzettend complex zijn. Om deze complexiteit te verminderen, is het van belang om te investeren in tools en resources voor ontwikkelaars die verder gaan dan alleen het kernproduct. Daarbij valt te denken aan concrete hulpmiddelen zoals documentatie, tutorials en voorbeeldcode, maar ook aan het opbouwen van een community en nieuwe kanalen voor support. 

Als bedrijf dat een API ter beschikking stelt voor tienduizenden gebruikers wereldwijd staat Developer Experience ook bij ons altijd voorop. Daarom willen we vandaag even de tijd nemen om terug te blikken op wat we in het afgelopen jaar hebben bereikt en daarnaast ook prijsgeven wat we in de toekomst van plan zijn. 

Clientbibliotheken voor de API

Om ontwikkelaars een goede Developer Experience te kunnen geven, wilden we zo snel mogelijk clientbibliotheken beschikbaar maken. Zulke bibliotheken bieden ontwikkelaars immers een werkomgeving waarmee ze vertrouwd zijn, waardoor ze in staat zijn om betere en eenvoudigere code te schrijven. 

Clientbibliotheken waren daarom dan ook de eerste opensourceprojecten waarmee DeepL aan de slag ging. Open source maakt het voor gebruikers gemakkelijker om bibliotheken aan te passen en om feedback met ons te delen.

De eerste clientbibliotheek die we konden aanbieden, verscheen in augustus 2021 voor Python. Sindsdien hebben we ook clientbibliotheken voor .NET, Node.js, PHP en Java beschikbaar gemaakt. Een jaar later, in augustus 2022, waren onze clientbibliotheken al verantwoordelijk voor ongeveer 7% van alle DeepL API-oproepen (en dus voor miljarden vertaalde tekens), en duizenden API-gebruikers hebben voor ten minste één API-oproep gebruik gemaakt van een clientbibliotheek.  

In het komende jaar willen we nog minstens één nieuwe clientbibliotheek toevoegen, namelijk voor de programmeertaal Go. Daarnaast zullen we onze bestaande clientbibliotheken natuurlijk ook blijven bijwerken om ervoor te zorgen dat deze ook zonder problemen met nieuwe functies van onze API kunnen omgaan.  

Heb je onze clientbibliotheken uitgeprobeerd en wil je ideeën of feedback met ons delen? Maak dan een GitHub-issue aan in de juiste repository om het gesprek op gang te brengen. Bovendien houden we de Stack Overflow in de gaten voor de tag #deepl.

OpenAPI-specificatie

In juni 2022 publiceerden we een OpenAPI-specificatie voor de DeepL API. Hiermee hebben we het voor gebruikers gemakkelijker gemaakt om bibliotheken te maken voor programmeertalen die DeepL nog niet ondersteunt en om de API te verkennen met behulp van Swagger UI of Postman. Daarnaast stelt de specificatie ons in staat om onze API-documentatie op een consistente en efficiënte manier bij te houden. Op basis van de OpenAPI-specificatie hebben we onze documentatie onlangs ook herschreven, waardoor het voor ons gemakkelijker wordt om deze in de toekomst bij te werken.  

Zo zijn we van plan om voorbeeldcode voor clientbibliotheken aan de documentatie toe te voegen om de reeds bestaande cURL- en HTTP-voorbeelden aan te vullen. 

Voor meer informatie over de OpenAPI-specificatie kun je in GitHub terecht.

Voorbeeldprojecten voor de API

In het afgelopen jaar hebben wij van onze gebruikers regelmatig de vraag gekregen of wij ter inspiratie voor hun eigen werk met de DeepL API voorbeeldcode en voorbeeldprojecten ter beschikking zouden kunnen stellen. In augustus 2022 publiceerden we ons allereerste voorbeeldproject voor de DeepL API: een voorbeeldscript voor Google Sheets dat gebruikers in staat stelt om de inhoud van cellen te vertalen met DeepL. Net als bij onze andere GitHub-projecten gaat het bij dit voorbeeldproject om opensourcesoftware onder de MIT-licentie. 

Op dit moment zijn we al druk bezig met het plannen van andere voorbeeldprojecten die we in GitHub kunnen delen. Ideeën zijn natuurlijk van harte welkom: open dus gerust een ticket als je feedback voor ons hebt!  

En over feedback gesproken: als er iets is dat wij zouden kunnen doen om onze Developer Experience nog beter te maken, dan kun je ons natuurlijk altijd een berichtje sturen. In de tussentijd zullen wij onze API blijven verbeteren door nieuwe talen en functies toe te voegen en onze woordenlijst-functie van nieuwe talencombinaties te voorzien. 

Zin om aan de slag te gaan met de DeepL API? Meld je dan nu aan om 500.000 tekens per maand gratis te vertalen.

Kort samengevat:

1. Een jaar geleden, in augustus 2021, hebben we onze eerste API-clientbibliotheek beschikbaar gemaakt voor Python en sindsdien is deze bibliotheek gebruikt door duizenden API Free- en API Pro-gebruikers. 
2. Naast Python hebben we tegenwoordig clientbibliotheken voor .NET, Node.js, PHP en Java evenals een OpenAPI-specificatie. 
3. We zullen ook in de toekomst blijven investeren in nieuwe clientbibliotheken, voorbeeldcode en verbeterde documentatie om de Developer Experience te verbeteren.