Tag: api-design

API design ist der Prozess der Bestimmung und Offenlegung einer einheitlichen Methode Signaturen, die Werte zurückgeben, und die Dokumentation bestimmungsgemäß für die Verwendung durch andere Entwickler zu ermöglichen, die den programmatischen Zugriff auf Daten.

Mit Anmerkungen, um sicherzustellen, dass der Rückgabewert der Methode wird nicht verworfen

Anzahl der Antworten 7 Antworten
String in Java unveränderlich ist. Der folgende Codeausschnitt ist, grob gesagt, "falsch". String s = "hello world!"; s.toUpperCase(); //"wrong"!! System.out.println(s); //still "hello world!"!!! Obwohl dies "falsch" ist, wird der code kompiliert und ausgeführt wird, vielleicht, um die

Beste Weg für die Gestaltung einer Paginierung Endpunkt in einem RESTful-Web-Service

Anzahl der Antworten 3 Antworten
Habe ich meine /entities Endpunkt auf meine RESTful-Web-Service, das gibt alle die gespeicherten Objekte auf die Datenbank, wenn der Aufruf mit einem GET Anfrage. Was möchte ich jetzt schaffen, ist eine Paginierung Funktionalität. Die Fähigkeit zum abrufen

GB Deutsch oder Englisch, US-Englisch?

Anzahl der Antworten 28 Antworten
Wenn Sie haben eine API, und Sie sind eine UK-basierte Entwickler-mit einem sehr internationalen Publikum, sollten Ihre API setColour() oder setColor() (Um ein Wort, wie ein einfaches Beispiel.) UK-basierten Ingenieure sind oft sehr defensiv über Ihre "richtige"

Beste Weg, um erstellen-REST-API für dauerhafte Aufgaben?

Anzahl der Antworten 3 Antworten
Angenommen ich habe 2 Server. Das erste ist ein service, das bietet einige Berechnungen, die lange Zeit (Minuten bis Stunden). Den zweiten server mit diesem Dienst zu haben, einige Daten berechnet. Ich versuche zur Konstruktion einer REST-API

Wie behandeln die Paginierung in retrofit

Anzahl der Antworten 2 Antworten
Baue ich ein app mit Nachrüstung. Alles funktioniert swimmingly, aber ich bin besorgt über die Größe meiner API-Anfragen und zu teilen möchten Sie mit Paginierung. Was wäre die beste Strategie, um durch die API automatisch mit Retrofit,

Open-source / freie-universal-EPG / XMLTV-Daten-API oder service, oder wie ein zu stellen?

Anzahl der Antworten 3 Antworten
Ich bin auf der Suche nach (ein open-source, auch bekannt als "free") Daten-Quelle für die universellen EPG /XMLTV-Dienste? Das Projekt muss überarbeitet/aktualisiert, Echtzeit-TV Planungsinformationen, in eine leicht HIERFÜR gültigen format. Es MUSS auch verfügbar sein, ohne Kosten

Kann die Basis-URL ändern in Stolzieren?

Anzahl der Antworten 2 Antworten
Ich habe derzeit umgesetzt Swagger und ich habe bemerkt, dass die Basis-url für die Ressourcen ist fest in der JSON-Ressource-Dateien, idealerweise würde ich gerne dem Benutzer die Möglichkeit zum ändern der Basis-url für verschiedene json verbages. So,

Unterschiede zwischen API-Entwicklung Plattform e.g APIGEE und ESB

Anzahl der Antworten 3 Antworten
Mich und mein team arbeiten, APIGEE ist ein API-Entwicklung Plattform, setzen einige Dienste in unserer Anwendung. Ich werde durch Ihre Dokumentation und auch versuchen zu verstehen, die Notwendigkeit, APIGEE oder jede andere API-Entwicklung Plattform wie Mashery. Ein

Was ist der standard für die Formatierung der Währung Werte in JSON?

Anzahl der Antworten 4 Antworten
Unter Berücksichtigung der verschiedenen Macken des Daten-Typen und-Lokalisierung, was ist der beste Weg für einen web-service zu kommunizieren, monetäre Werte zu und von Anwendungen? Gibt es eine Norm irgendwo? War mein Erster Gedanke, einfach die Nummer geben.

404 Nicht Gefunden oder Bad Request?

Anzahl der Antworten 1 Antworten
Lassen Sie uns sagen, dass wir haben die folgenden REST-Aufruf: GET api/companies/5 (get Gesellschaft mit id 5) Wenn das Unternehmen die '5' nicht gäbe, würden wir in der Regel Rückkehr eine 404 Not Found Antwort. Aber nun,

Wie richten Sie einen API-Schlüssel-system für Ihre Webseite?

Anzahl der Antworten 6 Antworten
Sagen wir, ich habe eine website mit einigen Informationen Zugang nach außen. Diese Informationen müssen Sie nur ändern, indem Sie den angesehenen client. Beispiel: Google Analytics oder WordPress-API-key. Wie kann ich ein system erstellen, wie das funktioniert

API-Endpunktsemantik

Anzahl der Antworten 1 Antworten
Ist eine API-Endpunkt der 'Methode', wie https://api.foursquare.com/v2/venues/ oder die vollständige URL einschließlich nicht-query-string-Parameter wie https://api.foursquare.com/v2/venues/5104 In anderen Worten, sind diese zwei separate Endpunkte oder als dem gleichen Endpunkt? http://myapi.com/somemodel/1 http://myapi.com/somemodel/2 InformationsquelleAutor der Frage Derek Dahmer | 2011-02-17

Warum wirft int num = Integer.getInteger ("123") NullPointerException?

Anzahl der Antworten 3 Antworten
Der folgende code löst NullPointerException: int num = Integer.getInteger("123"); Ist mein compiler aufrufen getInteger auf null, da es statisch? Das macht keinen Sinn! Was ist passiert? InformationsquelleAutor der Frage user282886 | 2010-06-26

Wann sollten wir unsere eigenen Java-Ausnahmeklassen erstellen?

Anzahl der Antworten 5 Antworten
einem guten design/Praxis-Sicht, Wann sollen wir die erstellen und verwenden von benutzerdefinierten java-exception-Klassen anstelle der bereits vorher in java? In einigen Anwendungen sehe ich fast keine, oder gar keine eigene exception-Klassen erstellt haben, machen Sie eine Anstrengung,

Warum gibt es keine getFirst (iterable) Methode?

Anzahl der Antworten 2 Antworten
Iterables präsentieren zwei Methoden für die getLast public static <T> T getLast(Iterable<T> iterable); public static <T> T getLast(Iterable<T> iterable, @Nullable T defaultValue); aber nur eine für getFirst public static <T> T getFirst(Iterable<T> iterable, @Nullable T defaultValue); Gibt

Best Practices und Richtlinien zum Entwerfen einer API

Anzahl der Antworten 5 Antworten
Was sind einige Richtlinien und best practices, die kann ich einhalten, um die während der Konzeption einer API? Auf das absolute minimum, ich weiß, dass eine API soll einfach zu bedienen sein und flexibel. Leider können diese

Warum wirft String.valueOf (null) eine NullPointerException?

Anzahl der Antworten 3 Antworten
laut der Dokumentation, die Methode - String.valueOf(Object obj) gibt: wenn das argument nulldann wird ein string gleich "null"; andernfalls wird der Wert von obj.toString() zurückgegeben. Aber wie kommt es, wenn ich versuche, dies zu tun: System.out.println("String.valueOf(null) =

Warum ist die Java-Datums-API (java.util.Date, .Calendar) so ein Problem?

Anzahl der Antworten 4 Antworten
Als die meisten Menschen sind sich schmerzlich bewusst, indem Sie nun die Java-API für den Umgang mit Kalender, Termine (insbesondere die Klassen java.util.Date und java.util.Calendar) sind ein heilloses Durcheinander. Aus der Spitze von meinem Kopf: Datum ist

Wann definiere ich objective-c Methoden?

Anzahl der Antworten 3 Antworten
Ich Lerne Objective-C, und ein C/C++ - hintergrund. In Objekt-orientierten C++, man muss immer erklären, Ihre Methode vor, die Sie definieren (implementieren), auch wenn es deklariert ist, in der übergeordneten Klasse. Im prozeduralen Stil C, IIRC, Sie

Token abgelaufen - JSON-REST-API - Fehlercode

Anzahl der Antworten 4 Antworten
Habe ich eine JSON-REST-API. Es gibt einen handshake, geben Sie ein token, das ist für 15 Minuten gültig. Alle Anrufe, die Sie tun, innerhalb dieser 15 Minuten funktionieren sollte ok. Nach den 15 Minuten bin ich wieder

REST-Design für Datei-Uploads

Anzahl der Antworten 1 Antworten
Ich brauche, um eine REST-API für eine Datei-upload-Dienst, der es einem Benutzer ermöglicht, zu: Öffnen Sie eine Sitzung Hochladen ein paar Dateien Die Sitzung schließen Und dann später, kommen Sie zurück und tun die Dinge mit den

Best Practices für API-Paginierung

Anzahl der Antworten 10 Antworten
Ich würde gerne einige Hilfe Umgang mit einer fremden edge-Fall mit einer paginierten API, die ich gerade Baue. Wie viele APIs, dieser paginiert große Ergebnisse. Wenn Sie query /foos, du bekommst 100 Ergebnisse (z.B. foo #1-100), und

Wann verwende ich Pfadparameter vs. Abfrageparameter in einer RESTful-API?

Anzahl der Antworten 7 Antworten
Möchte ich meine RESTful-API sehr vorhersehbar. Was ist die beste Vorgehensweise für die Entscheidung, Wann eine Segmentierung der Daten mit Hilfe der URI anstatt mithilfe von query params. Macht es Sinn für mich, dass der system-Parameter, die

Warum erlaubt Java das Überschreiben von Gleichheitszeichen (Object) in einem Enum nicht?

Anzahl der Antworten 4 Antworten
Habe ich bemerkt, dass das folgende snippet... @Override public boolean equals(Object otherObject) { ... } ...ist nicht zulässig für ein Enum, da die Methode equals(Object x) ist definiert als final im Enum. Warum ist das so? Ich

REST API Versionierung (nur Version der Darstellung, nicht die Ressource selbst)

Anzahl der Antworten 7 Antworten
Hatte ich einen Blick auf Best practices für die API-Versionierung?bin aber nicht ganz überzeugt von der Antwort, so ich bin Frage die Versionierung Teil wieder mit einem mehr spezifischen Beispiel. Ich bin mit zwei URIs (mit Versionierung

RESTful Design: Wann Sub-Ressourcen zu verwenden?

Anzahl der Antworten 6 Antworten
Beim entwerfen Ressource Hierarchien, Wann sollte man verwenden sub-Ressourcen? Ich verwendet, um zu glauben, dass wenn eine Ressource nicht existieren könnte, ohne ein anderes, es sollte dargestellt werden, wie seine sub-Ressource. Ich habe vor kurzem lief über

Wie definieren Sie eine gute oder schlechte API?

Anzahl der Antworten 14 Antworten
Hintergrund: Nehme ich einen Kurs an meiner Universität als "Software-Einschränkungen". In den ersten Vorträgen wurden wir zu lernen, wie zu bauen, gute APIs. Ein gutes Beispiel haben wir einen wirklich schlechten API-Funktion ist die Buchse public static

Was ist der richtige REST-Antwortcode für eine gültige Anfrage, aber leere Daten?

Anzahl der Antworten 12 Antworten
Beispielsweise führen Sie eine GET-Anforderung für users/9 aber es gibt keinen Benutzer mit der id #9. Welche ist die beste-Antwort-code? 200 OK 202 Akzeptiert 204 No Content 400 Bad Request 404 Nicht Gefunden InformationsquelleAutor der Frage IMB

Was ist der Goldstandard für Website-APIs? Twitter, Flickr, Facebook usw

Anzahl der Antworten 15 Antworten
Scheint, wie es gibt zwei Kategorien von APIs für die websites von heute. APIs, die es erlauben, die Funktionalität der Website erweitert werden, wie Facebook, Myspace, etc. Diese APIs zu sein scheinen sehr vielfältig. APIs, die es

Anwenden von LIMIT und OFFSET auf alle Abfragen in SQLAlchemy

Anzahl der Antworten 1 Antworten
Ich bin der Gestaltung einer API mit SQLAlchemy (Abfragen von MySQL), und ich möchte es zu zwingen, alle meine Fragen zu haben page_size (LIMIT) und page_number (OFFSET) Parameter. Ist es eine saubere Art und Weise, dies zu