Die wichtigsten API Prinzipien für ein erfolgreiches Blockchain API Produkt!

API Prinzipien für ein erfolgreiches API Produkt
Eine gute Blockchain Api muss es schaffen, das wichtigste Bedürfnis eines Softwareentwicklers zu befriedigen. Doch was ist dieses Bedürfnis und wie können wir es befriedigen? Das zeigen wir dir die wichtigsten API Prinzipien, die du wissen solltest.
Für eine gute Blockchain API ist ein gutes API Design nicht wegzudenken. Hierbei ist es wichtig zu verstehen, dass der Nutzer der API nicht ein Unternehmen, sondern der Softwareentwickler ist. Deshalb sollte das oberste Ziel sein, die Blockchain API für den Entwickler so ansprechend wie möglich zu gestalten. Nur dann wird die API auch genutzt und weiterempfohlen. Aber wie bekommen wir das hin?
Softwareentwickler wollen faul sein, nicht im negativen Sinne, sondern damit ist Effizienz gemeint. Es soll möglich sein, die API schnell und einfach zu benutzen. Wie muss eine API also sein, damit sie es den Entwicklern ermöglicht „faul“ zu sein. Dafür musst du die folgenden API Prinzipien erfüllen:

  • Intuitiv
  • Gut dokumentiert
  • Und meinungsstark sein

Was genau damit gemeint ist erklären wir dir im Folgenden.

Eine gute API muss intuitiv sein

Damit wir es dem Entwickler ermöglichen können faul zu sein, muss die Blockchain API intuitiv sein. Das bedeutet, dass er nicht viel Zeit investieren muss, um herauszufinden wie die API funktioniert. Sie sollte so selbsterklärend wie möglich sein und dem Entwickler erzählen was er tun soll. Hierbei solltest du zwei Regeln beachten:

  1. Regel: Ähnliche Dinge sollten ähnlich aussehen. Das bedeutet, dass du die Verwendung von gleichen Wortmusters verwenden solltest, um zu zeigen, dass zwei oder mehr Methoden, Klassen etc. die gleiche Bedeutung haben.
  2. Regel: Gefährliche Dinge sollten gefährlich aussehen. Wenn zum Beispiel eine Klasse oder Methode gefährliche Dinge tut, sollten diese auch gefährlich aussehen. Dadurch soll der Entwickler auf die Gefahr aufmerksam gemacht werden.

Eine gute API muss gut dokumentiert sein

Damit die Blockchain API einen Erfolg hat, muss sich jedoch nicht nur intuitiv sein, sondern auch gut dokumentiert sein. Dabei ist es entscheidend, dass die Dokumentation der API gut strukturiert und einfach zu verstehen ist. Das Ziel ist es, dass fast jede Frage durch die Dokumentation einfach und schnell beantwortet werden kann. Hierbei gibt es vier Regeln zu beachten.

  1. Einfache Fragen sollten einfach beantwortet werden.
  2. Die Dokumentation sollte langweilig aber gut strukturiert sein.
  3. Die Tutorials sollten interessant sein.
  4. Ein Quickstart, damit die API so schnell wie möglich benutzten werden kann.

api prinzipien

Eine gute API muss meinungsstark sein

Der letzte wichtige Faktor für eine erfolgreiche Blockchain API ist die Meinungsstärke. Das bedeutet, dass es sich für den Kunden anfühlen muss, als würde die API von nur einer Person gebaut worden sein. Deshalb müssen im Voraus Standards für die API festgelegt werden. Das Ziel hierbei ist es, dass alle Mitarbeiter, die an der Entwicklung der API beteiligt sind, wie eine Person denken sollten. Dadurch entsteht eine meinungsstarke API, die dem Kunden die Richtung weist. Zudem ist es dadurch schwer, die API falsch zu benutzen. Dies kann erheblich zum Erfolg der API beitragen.

Das sind unsere drei Erfolgsfaktoren einer guten API. Wenn du alle API Prinzipien berücksichtigst und in deinem API Design umsetzt, kann deine API am Markt akzeptiert werden und Erfolg haben.

Dir gefiel unser Artikel und möchtest mehr über Blockchain erfahren? Lerne neues, über Wie unterscheiden sich APIs? kennen.

Wenn du über die neusten Artikel informiert werden möchtest, folge uns auf Facebook, Pinterest und Steemit.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.