api-design, Seitenzahl 1

API-Design ist der Prozess zum Ermitteln und Darstellen einer Menge konsistenter Methodensignaturen, Rückgabewerte und Dokumentationen, die von anderen Entwicklern für den programmgesteuerten Zugriff auf Daten verwendet werden sollen.

Antworten

Overriding ToString () für Debugging und Logs - sollte die Zeichenfolge lokalisiert werden?

Ich entwerfe eine .NET-Bibliothek, die von anderen Entwicklern verwendet wird, die sowohl Web- als auch Desktop-Anwendungen erstellen. Ich überschreibe ToString() in verschiedenen Klassen, um Informationen zum Debuggen und zur Aufnahme in Anw...

05.11.2011, 15:12

Antworten

Open-Source / freie universelle EPG / XMLTV Daten API oder Service, oder wie man einen macht? [geschlossen]

Ich suche nach einer (Open-Source, aka "freien") Datenquelle für universelle EPG / XMLTV-Dienste? Das Projekt benötigt aktualisierte / aktualisierbare Echtzeit-TV-Planungsinformationen in einem leicht zu analysierenden Format. Es muss auch ko...

17.02.2011, 14:45

Antworten

Entwerfen von APIs in Java mit Top-Down-Ansatz - Ist das Schreiben des Javadoc der beste Ausgangspunkt?

Wann immer ich eine API in Java entwickeln muss, beginne ich normalerweise damit, meine IDE zu öffnen und die Pakete, Klassen und Schnittstellen zu erstellen. Die Methodenimplementierungen sind alle dumm, aber die Javadocs sind detailliert. I...

05.08.2011, 10:45

Antworten

Warum ist JavaMail Transport.send () eine statische Methode?

Ich überarbeite Code, den ich nicht geschrieben habe, der JavaMail verwendet, und habe ein wenig Schwierigkeiten zu verstehen, warum die JavaMail-API so entwickelt wurde, wie sie ist. Ich habe das Gefühl, wenn ich es verstehe, könnte ich einen b...

16.02.2010, 16:36

Antworten

Zufällig hohe Downloadzeit in Chrome?

Wir haben eine API, die zufällig eine hohe content download -Zeit in Chrome annimmt. Sie funktioniert immer in Firefox und benötigt nur ein paar ms . Die Antwortgröße ist 20 KB unkomprimiert und 4 KB komprimiert. Die gleiche Anfrage funktio...

28.11.2017, 04:49

Antworten

(Start, Ende) vs. (Start, Länge) im API-Design

Ich habe zwei alternative Konventionen gesehen, die bei der Angabe eines Bereichs von Indizes verwendet wurden, z. B. %Vor% gegen %Vor% Sie sind offensichtlich in Bezug auf das, was Sie mit ihnen tun können, gleichwertig. Der einzige Unt...

11.01.2013, 05:29

Antworten

Lebensdauerverlängerung von Datenelementen und API-Design von Provisorien

Angenommen, ich habe eine plattformübergreifende Klasse Path wie: %Vor% Die Funktion parent() member gibt den übergeordneten Pfad von this path zurück und gibt (zu Recht) ein neu erstelltes Path -Objekt zurück, das es repräsentie...

24.08.2016, 16:07

Antwort

HATEOAS Client Design

Ich habe viele Diskussionen hier auf SO gelesen, habe Jon Moores Präsentation gesehen (welche erklärte viel, btw) und lese Roy Fieldings Blog-Post auf HATEOAS, aber ich fühle mich immer noch ein wenig im Dunkeln, wenn es um Client-Design geht....

24.02.2012, 18:04

Antworten

REST-API-Entwurf: Weisen Sie den Server an, eine Reihe von Ressourcen zu "aktualisieren"

Wir haben einige Ressourcen auf einem REST-Server, der wie folgt strukturiert ist: /someResources/foo /someResources/bar /someResources/baz Dabei ist someResource eine Serverdarstellung eines weit entfernten verteilten Obj...

29.09.2010, 12:34

Antworten

Wie sollten Ausnahmen in einer RESTful API für Collection-Ergebnisse behandelt werden?

Wir entwickeln eine RESTful-API, um Sammlungen von Dokumenten zurückzugeben. Unsere erste Implementierung verwendet HTTP-Statuscodes, um anzugeben, ob eine Anfrage nicht erfüllt werden konnte. Dies scheint eine allgemein akzeptierte Best Practic...

16.04.2013, 16:21