Clientbibliotheken für die DeepL API und Developer Experience: Ein Jahresrückblick
Die Developer Experience – ein Begriff, der im Unternehmenslexikon noch relativ neu ist. Doch das Interesse an der Nutzererfahrung von Softwareentwicklern hat in den letzten zehn Jahren stark zugenommen.
Überraschend ist das nicht, denn moderne Softwareprojekte können äußerst komplex sein. Um diese Komplexität zu reduzieren, muss in Tools und Ressourcen für Entwickler investiert werden, die über das Kernprodukt hinausgehen: von der Dokumentation, den Tutorials und Codebeispielen bis hin zur Community und neuen Supportkanälen.
Als Unternehmen, das eine API für Zehntausende von Nutzern weltweit bereitstellt, steht die Developer Experience auch für uns stets an erster Stelle. Daher möchten wir Ihnen heute sowohl einen kurzen Überblick über unsere Arbeit im vergangenen Jahr als auch einen Ausblick auf zukünftige Projekte geben.
Clientbibliotheken für die API
Um Entwicklern eine gute Developer Experience zu bieten, wollten wir möglichst schnell Clientbibliotheken zur Verfügung stellen. Sie ermöglichen es, in einem vertrauten Ökosystem zu arbeiten und einfacheren, besseren Code zu schreiben.
Die Clientbibliotheken waren daher eines der ersten Open-Source-Projekte, an denen wir gearbeitet haben. Open Source hat den Vorteil, dass Nutzer Bibliotheken anpassen und uns ihr Feedback leichter mitteilen können.
Unsere erste Clientbibliothek erschien im August 2021 für Python. Seitdem sind weitere Bibliotheken für .NET, Node.js, PHP und Java dazugekommen. Nur ein Jahr später, im August 2022, wurden etwa 7 % aller DeepL API-Anfragen (was Milliarden von übersetzten Zeichen entspricht) über eine unserer Clientbibliotheken ausgeführt. Tausende von API-Nutzern haben außerdem mindestens eine Anfrage mit Hilfe einer Clientbibliothek gestellt.
Für das kommende Jahr planen wir, mindestens eine weitere Clientbibliothek hinzuzufügen, dieses Mal für Go. Zudem wollen wir weiterhin unsere bestehenden Clientbibliotheken aktualisieren, um alle neuen Funktionen der API zu unterstützen.
Sie haben Ideen oder Feedback zu unseren Clientbibliotheken? Erstellen Sie ein GitHub-Issue im entsprechenden Repository, um mit uns ins Gespräch zu kommen. Wir behalten außerdem immer den \#deepl-Tag bei Stack Overflow im Auge.
OpenAPI-Spezifikation
Im Juni 2022 haben wir eine OpenAPI-Spezifikation für die DeepL API veröffentlicht. Dies erleichtert es Nutzern, Clientbibliotheken für Programmiersprachen zu erstellen, die wir noch nicht unterstützen. Außerdem kann die API mit Tools wie Swagger UI und Postman erkundet werden. Die Spezifikation hilft uns auch dabei, die API-Dokumentation konsistent und effizient zu pflegen. Erst kürzlich haben wir unsere Dokumentation auf der Grundlage der OpenAPI-Spezifikation umgeschrieben, was es uns künftig erleichtert, die API-Dokumentation weiter zu verbessern.
So planen wir beispielsweise, die Dokumentation um Codebeispiele für die Clientbibliotheken zu erweitern, um die bereits vorhandenen cURL- und HTTP-Beispiele zu ergänzen.
Die OpenAPI-Spezifikation finden Sie hier auf GitHub.
Beispielprojekt für die API
Im vergangenen Jahr haben wir viele Anfragen von unseren Nutzern erhalten, die sich Codebeispiele und Beispielprojekte gewünscht haben, um Inspiration für ihre Arbeit mit der API zu erhalten. Im August 2022 haben wir daher unser allererstes Beispielprojekt für die DeepL API veröffentlicht: ein Skript für Google Sheets, das es ermöglicht, Zellen mit DeepL zu übersetzen. Wie unsere Clientbibliotheken ist auch dieses Beispielprojekt ein Open-Source-Projekt unter der MIT-Lizenz.
Aktuell planen wir noch, welche weiteren Beispielprojekte wir veröffentlichen möchten. Das Skript für Google Sheets ist aber auf jeden Fall erst der Anfang einer Reihe von Projekten, die wir auf GitHub teilen möchten. Wie immer gilt: Teilen Sie uns Ihr Feedback mit, indem Sie ein Ticket auf GitHub erstellen.
Sie denken, unsere Developer Experience könnte noch verbessert werden? Lassen Sie uns gerne eine Nachricht zukommen! In der Zwischenzeit werden wir weiter daran arbeiten, unsere API zu verbessern, indem wir neue Sprachen und Funktionen hinzufügen und die Glossarfunktion weiter ausbauen.
Sie möchten die DeepL API entdecken? Registrieren Sie sich jetzt, um bis zu 500.000 Zeichen pro Monat kostenlos zu übersetzen.
Kurz und knapp:
- Vor einem Jahr, im August 2021, haben wir unsere erste API-Clientbibliothek für Python veröffentlicht, die seitdem von Tausenden von Free- und Pro-Nutzern verwendet wird.
- Neben Python bieten wir auch Clientbibliotheken für .NET, Node.js, PHP und Java sowie eine OpenAPI-Spezifikation an.
- Wir werden die Developer Experience weiter verbessern, indem wir mehr Clientbibliotheken, eine optimierte Dokumentation und weitere Codebeispiele bereitstellen.