Das beste API Design für ein erfolgreiches Blockchain API Produkt!

Das beste API Design für ein erfolgreiches Blockchain API Produkt!

Was braucht eine gute API? Wie muss eine gute API aussehen? Wir zeigen dir wie ein gutes API Design für ein erfolgreiches Blockchain API Produkt aussieht.

Allgemeine Prinzipien einer guten API

Grundsätzlich sollte eine gute API eine Sache tun und diese so gut wie möglich. Die Funktionalität sollte einfach zu erklären sein. Dabei sollte die API so klein wie möglich sein, aber nicht kleiner. Das bedeutet, dass die API die gewünschten Anforderungen erfüllen sollte.(So wenig wie möglich, so viel wie nötig) Wenn du dir bei etwas unsicher bist, lass es lieber heraus. Du kannst später immer noch etwas hinzufügen, aber niemals etwas einfach so entfernen.
API Design

Realistische Erwartungen beibehalten

Für den Erfolg einer Blockchain API ist es grundsätzlich wichtige, diese Allgemein zu gestalten. Das bedeutet, dass die Entwicklung nicht für einen spezifischen Kunden, sondern für die größtmögliche Kundengruppe designed wird. Dabei wird es passieren, dass du Fehler machst. Das ist jedoch ganz normal und sollte dich auch nicht abschrecken.

Implementierung sollte API nicht beeinflussen

Die Implementierung einer API ist wichtig für den Erfolg des Produktes, jedoch sollten Implementierungsdetails nicht in die API genommen werden. Dabei ist es wichtig, nicht alles zu überspezifizieren.

Zugangsmöglichkeiten minimieren

Da die API direkten Zugang zu deinem Backend hat, ist es wichtig alles so verschlüsselt wie möglich zu halten. Deshalb sollte alles so privat wie möglich gehalten werden. Public Klassen sollten daher keine Public Felder besitzen. Du solltest versuchen, jegliche Information so gut wie möglich zu verstecken und dabei Kopplungen vermeiden.

Namen sind wichtig

Es klingt zwar nicht wichtig, aber Namen sind ein wesentlicher Erfolgsfaktor bei einem guten API Design. Deshalb sollte der Name deiner Blockchain API auf einen Blick erklären, was die API genau macht. Dabei solltest du immer die gleichen Namenstypen verwenden. Das bedeutet, dass du dich zum Beispiel für „Charge“ oder „Charging“ entscheidest und dann bei einem Namenstyp bleibst. Auch sollten die Namen so gewählt werden, dass der Code einfach zu lesen ist. Wir wollen es dem Entwickler so einfach wie möglich machen.

Dokumentation ist wichtig

Neben dem Namen ist die Dokumentation für den Erfolg der Blockchain API entscheidend. Du solltest jede Klasse, Methode, Konstruktor, Parameter und Exceptiones dokumentieren. Dabei ist es wichtig den Zustandsbereich sehr sorgfältig zu dokumentieren. Aber es ist nicht nur wichtig was dokumentierten werden soll, sondern auch wie es dargestellt wird und wie die Dokumentation bereitgestellt wird. Bei der Darstellung der Dokumentation ist es zu empfehlen, dass eine extra dafür konzipierte Software genutzt wird. Zudem könnte über ein API Management Tool oder über eine Webseite die Dokumentation bereitgestellt werden.

Das API Design beeinflusst die Performance

Schlechte Entscheidungen des API Design können einen wesentlichen Einfluss auf die Performance nehmen. Hierbei können schlechte Entscheidungen die Leistung der Blockchain API deutlich verringern. Solche schlechten Entscheidungen sind zum Beispiel die Veränderbarkeit von Daten, die Verwendung von Konstruktoren anstelle von statischen Klassen oder es werden keine Interfaces benutzt. Alle diese Entscheidungen können zu einer Verschlechterung der Performance führen.

API und Plattform müssen harmonieren

Es ist wichtig für den Erfolg der Blockchain API ist, dass sie neben deiner Plattform friedlich koexistiert. Um das zu erreichen, solltest du einfach das tun was üblich ist. Das bedeutet, dass du standardisierte Benennungskonventionen benutzen solltest. Zudem ist es wichtig veraltete Parameter und Rückgabetypen zu vermeiden. Versuche dabei die Plattform und die core APIS nachzuahmen. Hierbei hilft es, API freundliche Features zu benutzen wie zum Beispiel generics, varags, enums oder default arguments. API Fehler wie finalizer oder public static final arrays sollten aufjedenfall vermieden werden.

Zusammenfassung:

Es gehört einiges dazu, eine gute Blockchain API zu entwickeln. Du solltest realistische Erwartungen beibehalten, die Implementierung sollte die API nicht beeinflussen und es ist wichtig Zugangsmöglichkeiten zu gering wie möglich zu halten. Viele Entwickler machen sich über den Namen der API keine großen Gedanken, jedoch ist es ein wesentlicher Faktor für den Erfolg der API. Neben dem Namen ist die Dokumentation auch ein elementar wichtiger Teil und sollte nicht vernachlässigt werden. Schlussendlich sollte die API neben deiner Plattform harmonieren und es wird dir mit diesen Maßnahmen möglich sein, die Performance deiner API durch ein tolles API Design zu steigern.

Dir gefiel unser Artikel und möchtest mehr über Blockchain erfahren? Lerne neues, über Was ist eine API? 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.