Kapitel 9. Ressourcen für Entwickler
Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: translation-feedback@oreilly.com
Es reicht nicht aus, eine großartige API zu entwickeln, wenn niemand weiß, wie man sie nutzt. Wenn du deine API entwirfst, stelle sicher, dass du die Entwickler anleitest und befähigst, indem du ihnen die Lernmaterialien zur Verfügung stellst, die sie für den Erfolg brauchen.
Entwicklerressourcen sind eine Reihe von Ressourcen, die du deinen Entwicklern zur Verfügung stellen solltest, damit sie die Nutzung deiner API verbessern können. Es gibt viele Arten von Entwicklerressourcen, die jeweils unterschiedliche Aspekte des Entwicklungslebenszyklus betreffen. In diesem Kapitel gehen wir auf die wichtigsten Ressourcen ein, die die meisten Unternehmen anbieten. Außerdem geben wir dir einige Tipps und Tricks, wie du sie für dich nutzen kannst.
API-Dokumentation
Beginnen wir mit der grundlegendsten Ressource, die für jede API oder Plattform erforderlich ist: der Dokumentation.
Die Dokumentation ist der Ort, an dem Entwickler etwas über deine API erfahren. Egal, ob du eine einfache README-Datei bereitstellst oder eine vollständige Website für deine Entwickler entwickelst, es ist wichtig, dass du klar dokumentierst, wie sie deine API am effektivsten nutzen können. Zu einer guten Dokumentation gehören verschiedene Aspekte, die alle Phasen des Entwicklungslebenszyklus abdecken.
Erste Schritte
Getting Started Guides sind ...
Get Entwerfen von Web APIs now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
