Empfehlungen für das schreiben einer API
Ich bin zu schreiben, eine api und dachte, ich würde einige gute Empfehlungen auf Dinge zu suchen, wie schreibt man eine gute api.
Ich natürlich auch habe eine google-Suche, aber abgesehen von dieser von Dustin Diaz http://www.dustindiaz.com/api-writing-tips/, ich habe nicht wirklich finden konnten, gute Empfehlungen.
Was sind die Dinge, die Sie sich wünschen, Sie hätten es anders gemacht beim erstellen einer API?
Was war der größte Unterschied.
Ich davon aus, ich werde oauth verwenden.
Ich bin bewusst nicht mit details der api, da bin ich auf der Suche nach mehr allgemeiner Empfehlungen, die hoffentlich nützlich sein, um eine größere Anzahl von Menschen.
- Nur eine Allgemeine API-Vortrag von Joshua Bloch: Video: youtube.com/watch?v=aAb7hSCtvGw / Folien (PDF): aarontgrogg.com/wp-content/uploads/2009/09/...
Du musst angemeldet sein, um einen Kommentar abzugeben.
Wichtigsten Punkte, die ich würde empfehlen, Sie sich anzuschauen:
Auch, hier sind einige links, die Sie nützlich finden können:
Dies ist auch ein tolles Buch, die helfen können Sie loslegen:
Glaube ich nicht, das sprachunabhängig tag ist angemessen für diese Frage, und zudem braucht es eine bestimmte Sprache-tag. Entwerfen einer guten API erfordert eine Prüfung der Eigenschaften und der Ausdrücke der Sprache, mit der Sie arbeiten. Einige der wichtigsten überlegungen:
Also den besten Rat, den ich anbieten kann, um Ihre Frage, wie es steht (sprachunabhängig) ist nicht zu übernehmen, es sind sprachunabhängig universal-API-design-Richtlinien, und stattdessen lernen die Sprache(N), mit dem Sie arbeiten und die entsprechenden Redewendungen.
Einfach zu lernen
Einfach zu bedienen, auch ohne Dokumentation
Schwer zu Missbrauch
Funktionalität sollte einfach zu erklären
Namen sollten weitgehend selbsterklärend
Namen sollten konsistent sein: das gleiche Wort soll bedeuten, dass die gleiche Sache durch die ganze API
API sollte regelmäßig, und haben einige Symmetrie
Kredit gegeben
http://sharismlab.com/blog/2012/07/21/how-to-write-an-api-for-your-web-app/
Verstehen, wie Benutzer Ihre Anwendung.
Wenn Sie in der Lage zu notieren alle usecases der Anwendung, dann können Sie implementieren, die jeweils einen Anwendungsfall als Teil der API.
Am Ende des Tages haben Sie ein API, das bietet eine Reihe von usecases, dass Sie beschlossen. Weiter sollten Sie in der Lage zu verlängern API mit der Erweiterung der usecases und sollte in der Lage sein, um Abwärtskompatibilität zu gewährleisten.
API-Implementierung für Web-services:
Entscheiden Sie, welches Protokoll, Daten-Formate und-Authentifizierung, die Sie verwenden müssen.
Die meisten web-Dienste implementieren API mit folgenden Parametern.
API-Implementierung für Bibliotheken und SDK:
Erstellen Sie Prototypen, die eingefroren werden sollen, durch ein Leben aus.
Erweitern Sie API durch das hinzufügen von zusätzlichen Funktionen und ändern Sie nicht die vorhandenen Funktionen Prototypen.
Erlauben Sie Benutzer zu bieten, wie viele Eingänge Sie können als Argumente an Funktionen.
So kann die Anwendung Ihre Aufgabe als Benutzer gebeten, das zu tun.
Halten Benutzer in Geist und API sollten die Benutzer erlauben, um es mit minimalem Aufwand.
Finden Sie:
Eine Einführung in die APIs : https://zapier.com/learn/apis