it-swarm.com.de

Mit welchen Methoden testen Sie die Benutzerfreundlichkeit einer API?

Das Testen der Benutzerfreundlichkeit einer Programmierschnittstelle ist mit vielen Herausforderungen verbunden. Es fühlt sich ganz anders an als das Testen einer grafischen Interaktion. Der Benutzer kann fast alles jederzeit tun, im Gegensatz zu einer grafischen Oberfläche, die eine Reihe hervorstechender Optionen bietet.

Mit welchen Methoden testen Sie APIs? Welche Ergebnisse haben Sie erzielt?

14
Alex Feinman

Alex 'Frage war, wie man eine API testet, nicht was eine gute API ausmacht. Die Überwachung nach der Bereitstellung scheint mir von entscheidender Bedeutung zu sein. Es ist sehr schwierig, wenn nicht unmöglich, im Voraus zu wissen, für welche Zwecke Entwickler Ihre API einsetzen möchten, sobald sie live geschaltet wird. Durch das Protokollieren guter Anforderungen erfahren Sie, welche Funktionen beliebt sind. Durch das Protokollieren fehlerhafter Anforderungen und Fragen zur Benutzerunterstützung erhalten Sie jedoch möglicherweise einen besseren Einblick in Aspekte der API, die verbessert werden müssen. Wenn Sie über die Ressourcen verfügen (und diese für Ihre Domain geeignet sind), können Sie durch Generieren einer Dashboard-Ansicht Ihres Dienstes/Ihrer API von Anfang an Verbesserungen verfolgen und priorisieren.

Ich denke, vor der Bereitstellung können Sie vor allem die Zufriedenheit der Entwickler und die "Eleganz" des Codes messen, der gegen die API geschrieben wurde. Beides sehr subjektive Dinge zu testen. Ich nehme an, dass es hilfreich sein könnte, eine gute Reihe von primären Anwendungsfällen zu haben.

11
Ian Dickinson

2006 habe ich versucht, ein JavaScript-Framework auszuwählen. Ich habe Prototype, Dojo, Behavior, MooTools und jQuery ausprobiert. Ich habe mich aus einem Grund für jQuery entschieden: Die API hat für mich Sinn gemacht und war einfach. Das jQuery-Team und insbesondere John Resig sind von der Einfachheit der API besessen. Sie haben die universelle Wahrheit über APIs verstanden: Einfach ist

  1. verglichen mit was? und
  2. einfach für wen?

Kenne dein Publikum. Was sind sie gewohnt? In jQuery waren das Publikum Leute, die CSS kannten, daher ist die Syntax sehr CSS-ähnlich. Hier einige allgemeine Tipps:

  • Kürzer ist besser . Kurze Wörter, kurze Syntax. TinyUrls. Halte es einfach und kurz.
  • Verwenden Sie eine vernünftige Sprache . Nennen Sie etwas nicht "bla", wenn es in 50% der Fälle ein "nicht bla" ist.
  • Verwenden Sie eine konsistente Grammatik . Sagen Sie nicht "Update" an Ort und Stelle und "Updates" in einem anderen. Verwenden Sie immer die gleiche Zeitform und die gleichen grammatikalischen Konventionen.
  • Ein guter API-Browser ist unerlässlich . Überprüfen Sie dieses aus ExtJS . Super nützlich. auch jQuery API .
  • Sinn für Humor . Es mag irrelevant klingen, aber Ingenieure sind auch Menschen und ein Löffel Zucker hilft immer dabei, dass die Medizin sinkt. Ich habe eine Javascript-Datei namens Munchkin.js erstellt und die API-Aufrufe heißen Munchkin-Funktionen. Die Ingenieure lächelten und viele Interaktionen wurden geglättet.
  • Überlegen Sie es sich jetzt , bevor jemand damit anfängt. Sobald es da draußen ist, kannst du den Geist nicht mehr in die Flasche zurückbringen.

Ich hoffe diese sind ein bisschen hilfreich.

7
Glen Lipka

Eine API ist nur so gut wie ihre Dokumentation.

Sie können eine API testen, indem Sie einem Entwickler die Dokumentation zeigen und ihn dann bitten, zu erklären, wie Teile davon funktionieren.

3
Philip Morton

Ich denke, dass die beste Methode, um Usability-Tests für eine API bereitzustellen, darin besteht, eine Liste der häufigsten Anwendungsfälle anzugeben und Entwickler, die mit der API absolut neu sind, zu bitten, diese abzuschließen. Dann sollten Sie ihre Probleme, Rückmeldungen, Kommentare usw. analysieren.

Sie können lesen, wie wir Dropbox API-Usability-Tests durchgeführt haben: http://www.apiusabilitytesting.com/usability-review-dropbox-api/

3
DenisL

Führen Sie Usability-Tests durch. In diesem Fall ist es wahrscheinlich etwas zeitaufwändig, aber es wurde getan. Lesen Sie zum Beispiel das Papier Auswirkungen auf die Benutzerfreundlichkeit des Erfordernisses von Parametern in Objektkonstruktoren von Stylos und Clarke.

Da ich noch keine Usability-Tests für eine API durchgeführt habe, würde ich den zitierten Artikel nachahmen. Grundsätzlich würde dies bedeuten, repräsentative Programmieraufgaben für die Teilnehmer über die API zu erstellen.

0
Illotus