Читать книгу API-Design - Kai Spichale - Страница 43

Was würden Sie über eine Bibliothek oder einen Dienst denken, wenn Sie beim erstmaligen Ausprobieren schon nach wenigen Minuten falsch geschriebene Bezeichner oder Inkonsistenzen finden? Sie würden sich vermutlich fragen, ob Sie an dieser Stelle abbrechen und Ihre Arbeit mit einer Alternative fortsetzen sollten.

Berühmte API-Typos

Als Ken Thompson, der Erfinder von Unix, einmal gefragt wurde, was er anders machen würde, wenn er Unix noch einmal neu schreiben würde, antwortete er: »Ich würde create mit einem 'e' schreiben.« Gemeint war die Funktion creat zur Öffnung eines Dateideskriptors für I/O-Operationen. Auch der HTTP-Header refer(r)er wurde falsch geschrieben. Das Gleiche gilt für mnemonic in der Funktion SHStripMneumonic. Der Schreibfehler fiel zunächst nicht auf oder wurde als unwichtig eingestuft, weil diese Funktion nur intern verwendet wurde. Als jedoch später die betreffende Bibliothek ohne weitere Qualitätssicherung veröffentlicht wurde, war es zu spät. Der Name konnte nicht mehr korrigiert werden. Denn eine Änderung hätte Auswirkungen auf alle Programme, die diese Funktion verwenden.

Diese Art von einfachen Fehlern kann man leicht aufspüren und beheben. Sie können beispielsweise eine Kollegin oder einen Kollegen bitten, ein Review zu machen, denn bekanntlich ist man blind für seine eigenen Fehler. Feedback ist insgesamt sehr wichtig für den Entwurf einer API. Zeigen Sie die entworfene API Ihrem Team und führen Sie Gespräche mit Benutzern der API, um Feedback zu sammeln. Auch negatives Feedback hilft. Je mehr Informationen Ihnen zur Verfügung stehen, desto besser sind Ihre Chancen, eine gute API zu entwerfen.