Als «api-design» getaggte Fragen

Im API-Design (Application Programming Interface) werden bewährte Methoden zum Erstellen von Bibliotheken für allgemeine Zwecke oder zur öffentlichen Verwendung erläutert.

3
Gründe für die nicht intuitive Implementierung von C # String.Split ()
Wenn ich in C # eine stringdurch eine andere teilen möchte, muss stringich so etwas tun: testString.Split(new string[] { "anotherString" }, StringSplitOptions.None); Aus der überladenen String.SplitMSDN-Dokumentation können wir die Implementierung und den Grund für einen solchen Aufruf ersehen. Ich komme aus Python und kann nur schwer richtig verstehen, warum ein …
3
Wie entwerfe ich eine REST-API für Nicht-CRUD-Operationen?
Ich versuche, eine Reihe von SOAP-basierten Diensten in eine RESTful-API zu konvertieren. Ich begann mit der Identifizierung von Ressourcen durch Analyse der Operationsnamen und erhielt die Ressource Subscription. Wenn ich den Status des Abonnements aktualisieren muss, kann ich nicht einfach eine POSTAnfrage an den Server senden , da ich keinen …
2
Wie entwerfe ich API-Endpunkte zum Posten eines untergeordneten Objekts und zum Abrufen aller untergeordneten Elemente aller Eltern?
Zum Beispiel habe ich Entitäten: Client, Bericht. Der Client verfügt möglicherweise über viele Berichte, und ich denke, der Endpunkt für eine einzelne Berichtsverwaltung sollte wie folgt verschachtelt sein: /clients/{client_id}/reports/{report_id} Wie für alle Berichte eines Clients wird der Enpoint erwartet: /clients/{client_id}/reports Aber wie sollte ein Endpunkt aussehen, um alle Berichte aller …
11 rest  api  api-design 
2
Warnsystemarchitektur
Ich möchte ein System erstellen, das Warnmeldungen von verschiedenen Programmen verarbeitet und diese Warnungen per E-Mail an Down-Wind-Verbraucher verarbeiten kann. Dies alles würde über ein internes Netzwerk enthalten sein. Ich denke, ich möchte, dass die grundlegende Architektur ungefähr so ​​aussieht: Das Hauptanliegen, das ich derzeit habe, ist das "Message Handler" …
1
Warum wurden Null-Safe-Operatoren (z. B. „Elvis-Operator“) als Teil von Java 7s „Project Coin“ abgelehnt?
Eine der vorgeschlagenen Funktionen für Java 7s "Project Coin" war der "Elvis-Operator". In einem Bericht einer JavaOne-Präsentation 2009 zu Project Coin wurde dies als solches beschrieben: Eine der "kleinen Funktionen", die in dieser Präsentation behandelt werden, ist der sogenannte "Elvis-Operator", eine präzisere Version des ternären Operators. Bei der Verwendung von …
10 java  api-design 
4
Link zu relevanter Dokumentation in Fehlermeldung einfügen?
Wir erstellen eine kommerzielle Bibliothek und Codebeispiele, die von externen Entwicklern verwendet werden. Wir haben eine (geschlossene, registrierten Benutzern zur Verfügung stehende) Dokumentation, in der ausführlich erläutert wird, wie die Bibliothek verwendet wird. Viele der Entwickler sind Erstbenutzer, daher treten viele rudimentäre Fehler auf. Ist es angebracht, Links zur Dokumentation …
2
Ist das 'Demeter-Gesetz' auf öffentliche / API-Methodensignaturen anwendbar?
Angesichts der Tatsache, dass Änderungen an der API / öffentlichen Methodensignatur minimal sein sollten, um zu verhindern, dass die Clientcodes, die diese Methoden verwenden, beschädigt werden, habe ich mich gefragt, ob das Demeter-Gesetz auf diese weniger anwendbar ist. Ein einfaches Beispiel: class Account() { double balance; public void debit(Transaction t) …
5
API-Design-Fallstricke in C [geschlossen]
Geschlossen . Diese Frage basiert auf Meinungen . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage, damit sie durch Bearbeiten dieses Beitrags mit Fakten und Zitaten beantwortet werden kann . Geschlossen vor 4 Jahren . Was sind einige Fehler, die Sie in C-APIs verrückt …
10 c  api-design  pitfalls 
2
Wie vermeide ich die unbefugte Verwendung einer API?
Ich muss ein "Widget" entwerfen, ein Skript, das Partner in ihre Websites einbetten, um eine Benutzeroberfläche anzuzeigen und unsere API aufzurufen. Grundsätzlich werden unsere Daten auf diesen Websites basierend auf einigen IDs angezeigt, die sie in unseren API-Aufrufen bereitstellen. Was wir vermeiden möchten, ist, dass jemand die API missbraucht und …
3
Wie würde ich eine TryParse-Methode entwerfen, die im Falle eines Analysefehlers detaillierte Informationen liefert?
Beim Parsen von Benutzereingaben wird generell empfohlen , keine Ausnahmen auszulösen und abzufangen, sondern Validierungsmethoden zu verwenden. In der .NET-BCL ist dies beispielsweise der Unterschied zwischen int.Parse(löst eine Ausnahme für ungültige Daten aus) und int.TryParse(Rückgabe falsefür ungültige Daten). Ich entwerfe meine eigenen Foo.TryParse(string s, out Foo result) Methode und ich …
9 c#  .net  api-design 
3
Ist es eine schlechte Praxis, wenn eine API-Objektdefinition Referenz-IDs von Drittanbietern als Eigenschaften enthält?
So was: Campaign: type: object properties: id: type: string description: "A GUID identifier" referenceId: type: string description: "A consumers identifier they have used to map their own systems logic to this object." name: type: string description: "'Great Campaign 2017' as an example" Ich bin besorgt über die Referenz-ID . Die …
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.