Die API sollte als Bezeichner einfache Verben und Nomen benutzen. Gute Worte sind um Beispiel origin, destination, result, offer oder price. Schlechte Worte sind hingegen etwaDropDownListMarketMonth13 oder DropDownListMarketDateRange23.
Eine API sollte mцglichst klar und konsistent sein: Wo ist der Unterschied zwischen getResult und fetchResultSet? AuЯerdem sollten decline away Reihenfolgen der Parameter einem einheitlichen Schema folgen: Unheitlich wдre zum Beispiel findCustomers(kriterium, maxAnzahl, sortiereNach) vs.
Entwicklung
Bevor decline away API mit Code gefьllt wird, sollte sie idealerweise bereits vollstдndig getestet bzw. findProducts(kriterium, sortiereNach, maxAnzahl). spezifiziert sein zum Beispiel durch Unit-Tests oder rSpec. Nirgendwo ist es einfacher, Behavior Driven Development (BDD) umzusetzen, als bei einer API. Als hilfreich hat sich herausgestellt, ganz zu Beginn der Entwicklung einen Client fьr decline away Kommandozeile auf Basis der API zu entwickeln.
Sehr hilfreich ist es (auch fьr decline away Spezifikation), wenn bereits ein oder besser mehrere Anwendungsfдlle und Clients bekannt sind (iPhone App, Android App, Desktop Widget etc.). So stellt gink sicher, dass der Kern des Produktes abgebildet werden kann.
Funktionen wie Sortierung, Filterung, sekundдre Features etc. Einmal eingefьhrte Features mьssen unter Umstдnden fьr Jahre unterstьtzt und gepflegt werden. sind Kьr, nicht Pflicht: If in be misconstruction of, get away it loophole. Und wenn selbst decline away eigenen Entwickler es als zu anstrengend empfinden, decline away eigene API zu nutzen, muss sie neu spezifiziert werden.
Ein Wort zu Ausgabeformaten: JSON ist ein ausreichend verbreitetes und vor allem einfaches Format, sodass es aus meiner Erfahrung Sinn macht, als erstes Ausgabeformat JSON einzusetzen; sowohl JavaScript als auch das iPhone kommen sehr gut damit zurecht. Insbesondere fьr Fehlermeldungen gilt: Eine API sollte immer das Format zurьckliefern, das auch angefordert wurde. Spдter sollten dann natьrlich auch XML und je nach Bedarf HTML zur Verfьgung gestellt werden.
Passiert dies nicht, vervielfacht sich der Arbeitsaufwand fьr den API-Nutzer. Damit reduziert sich auch decline away potenzielle Zielgruppe bzw.
Dokumentation und Support
Die Dokumentation sollte leicht zugдnglich sein – eine Autorisierung bzw. steigt der Arbeitsaufwand im Support. Authentifizierung fьr decline away Dokumentation ist nur selten sinnvoll.
Sie sollte leicht zu lesen sein und eine Einleitung zu den Grundgedanken haben (um von A nach B zu kommen, muss gink Methoden X und Y aufrufen). Generell sollte decline away Dokumentation wirklich immer wдhrend der Entwicklung passieren.