Wie man besseren Code schreibt Teil 3

11. Code überarbeiten, wenn nötig Man sollte sich nicht scheuen, seinen Code zu überarbeiten, wenn es notwendig ist. Software entwickelt sich weiter, und das sollte man auch. Es ist besser, eine technische Schuld loszuwerden und das Stück Code zu überarbeiten, als es mit sich herumzutragen und sich daran die Zähne auszubeißen. Man sollte sich hin und wieder etwas Zeit nehmen, um seinen Code durchzugehen, und ihn zu überarbeiten und zu verbessern, anstatt eine weitere Funktion […]

Wie man besseren Code schreibt Teil 2

6. Das Rad nicht neu erfinden Programmieren macht Spaß. Als Ingenieure neigen wir dazu, für fast alles unsere eigenen Lösungen zu schreiben, denn wir lieben es, Probleme zu lösen. Das ist jedoch nicht immer sinnvoll. Man sollte versuchen, andere Frameworks, Tools und Dienste zu nutzen und sich auf die Lösung des eigenen Problems zu konzentrieren. Es gibt bereits so viel großartige Software, die man nutzen kann – meist sogar kostenlos. Man sollte sie nutzen! Jede […]

Wie man besseren Code schreibt Teil 1

Es hat sich herausgestellt, dass guter Code meist die gleichen Eigenschaften hat. Er ist leicht zu lesen, er ist leicht zu verstehen, er ist leicht zu pflegen und zu erweitern. Er ist so komplex wie nötig, aber so einfach wie möglich. In diesem Beitrag wird versucht zu beschreiben, was „guter Code“ bedeutet. 1. Die Grundlagen verstehen Beginnen wir mit etwas Offensichtlichem (aber wirklich Wichtigem). Egal, was man im Leben tut, man sollte die Grundlagen verstehen. […]

Wie man bessere APIs entwickelt Teil 3

11. Gib die bei POST erstellte Ressource zurück Es ist eine gute Idee, die erstellte Ressource zurückzugeben, nachdem sie mit einer POST-Anfrage erstellt wurde. Das ist vor allem deshalb wichtig, weil die zurückgegebene, erstellte Ressource den aktuellen Zustand der zugrundeliegenden Datenquelle widerspiegelt und vielleicht aktuellere Informationen enthält (z. B. eine generierte ID). // Request: POST /users{    „email“: „jdoe@averagecompany.com“,    „name“: „John Doe“}// Response{    „id“: „T9hoBuuTL4“,    „email“: „jdoe@averagecompany.com“,    „name“: „John Doe“} 12. […]

Wie man bessere APIs entwickelt Teil 2

6. Akzeptiere API-Schlüssel-Authentifizierung Wenn eine API von einer dritten Partei aufgerufen werden muss, ist es sinnvoll, die Authentifizierung über API-Schlüssel zuzulassen. API-Schlüssel sollten mit einem benutzerdefinierten HTTP-Header (z. B. Api-Key) übergeben werden. Sie sollten ein Ablaufdatum haben, und es muss möglich sein, aktive Schlüssel zu widerrufen, damit sie ungültig gemacht werden können, falls sie kompromittiert werden. Vermeide das Einchecken von API-Schlüsseln in die Versionskontrolle (verwende stattdessen Umgebungsvariablen). 7. Verwende sinnvolle HTTP-Statuscodes Verwende konventionelle HTTP-Statuscodes, um […]