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.

1
Idiomatisches Umbrechen der C ++ - Vorlagentyp-API in C.
Ich arbeite daran, eine C ++ - API zu verpacken, die den Zugriff auf einen Datenspeicher (Hazelcast) in C-Funktionen ermöglicht, damit auf den Datenspeicher auch über C-only-Code zugegriffen werden kann. Die Hazelcast C ++ - API für die Map-Datenstruktur sieht folgendermaßen aus: auto map = hazelcastClient->client->getMap<int, string>(mapName); map.put(key, value); Es …
9 c++  c  api-design 
2
Sollten Event-Listener in schwachen Referenzen gehalten werden?
Normalerweise sollten Ereignis-Listener Objekte, die sie registriert haben, nicht überleben. Bedeutet dies, dass Ereignis-Listener standardmäßig von schwachen Referenzen gehalten werden sollten (in schwachen Sammlungen gespeichert, in denen die Objekt-Listener registriert sind)? Gibt es gültige Fälle, in denen der Hörer seinen Schöpfer überleben sollte? Oder ist eine solche Situation ein Fehler …
1
Versionierungs-APIs
Angenommen, Sie haben ein großes Projekt, das von einer API-Basis unterstützt wird. Das Projekt liefert auch eine öffentliche API, die Endbenutzer verwenden können. Manchmal müssen Sie Änderungen an der API-Basis vornehmen, die Ihr Projekt unterstützt. Beispielsweise müssen Sie eine Funktion hinzufügen, die eine API-Änderung oder eine neue Methode erfordert oder …
5
Entwerfen einer funktionsbasierten RESTful-API
Bitte führen Sie einen Streit zwischen mir und einem Freund. Wir entwickeln derzeit eine Produkt-API. Unsere Produkteinheit sieht so aus { "Id": "", "ProductName": "", "StockQuantity": 0 } Produktverkäufe werden von Dritten abgewickelt und sind verpflichtet, uns die gekaufte Menge mitzuteilen, damit das StockQuantityFeld verkleinert werden kann. Mein Ansatz: PUT …
2
Verwalten und Dokumentieren von API-Endpunkten vieler Anwendungen in einer Microservice-Architektur
Ich denke, einer der größten Probleme bei der Arbeit mit Microservices besteht darin, sicherzustellen, dass die APIs gut dokumentiert sind und APIs ihr Verhalten nicht ändern, ohne die nachgelagerten Anwendungen zu beeinträchtigen. Dieses Problem wird verstärkt, wenn Sie viele Dienste haben, die voneinander abhängig sind. Vielleicht machen Sie an diesem …
5
Rest API Design - Mit IDs oder Literal Strings arbeiten?
Sollte die API beim Entwerfen eines RESTful-Webdiensts so ausgelegt sein, dass sie die ID für Zeichenfolgen für Werte verwendet, die zwischen dem Server hin und her übertragen werden? Hier ein Beispiel: Angenommen, ich habe eine Mitarbeiterressource mit Status- und Geschlechtsattributen. In der Datenbank Status und Geschlecht und separate Tabellen und …
8 rest  api-design  json 
1
Nach dem Buch REST vs Too Many Requests
Aus Roy Fieldings Kommentar zu seinem eigenen Artikel, in dem gefälschte REST-Apis entschlüsselt werden : Eine wirklich RESTful API sieht aus wie Hypertext. Jede adressierbare Informationseinheit trägt eine Adresse, entweder explizit (z. B. Link- und ID-Attribute) oder implizit (z. B. abgeleitet von der Medientypdefinition und Repräsentationsstruktur). Abfrageergebnisse werden durch eine …
8 rest  api  api-design 
4
Die Abhängigkeitsinversion erweitert die API und führt zu unnötigen Tests
Diese Frage hat mich einige Tage lang beschäftigt, und es scheint, als würden sich mehrere Praktiken widersprechen. Beispiel Iteration 1 public class FooDao : IFooDao { private IFooConnection fooConnection; private IBarConnection barConnection; public FooDao(IFooConnection fooConnection, IBarConnection barConnection) { this.fooConnection = fooConnection; this.barConnection = barConnection; } public Foo GetFoo(int id) { …
3
Brechen von API-Änderungen: Wie kann ich Bibliotheksbenutzern den Übergang erleichtern?
In der Vergangenheit habe ich die Standardmethode zum Hinzufügen von @DeprecatedAnmerkungen zu API-Methoden verwendet, die in einer späteren Version entfernt werden. Jetzt bereite ich eine Hauptversion für eine Bibliothek vor, bei der viele API-Teile entfernt und umbenannt werden. Um den Übergang für vorhandene Benutzer zu vereinfachen, kann es möglicherweise hilfreich …
1
Paging-Strategien: Page Token vs Skip / Start Index
Ich sehe, dass immer mehr neue APIs Seitentoken verwenden, mit denen der Benutzer zwischen den Ergebnisseiten wechseln kann, die viele Elemente enthalten. Aus Sicht des API-Designers ist mir jedoch nicht klar, welche Vorteile die Verwendung eines Tokens hat, wenn der Benutzer angibt, wie viele Elemente er überspringen möchte. Also hier …
2
Partitionieren von REST-API-Ressourcen in Bereiche, die auf Geschäftsdomänen basieren
Ist es in einer REST-API für Hauptanwendungen, die mehrere verwandte Domänen abdeckt, sinnvoller, Ressourcen basierend auf der Geschäftsdomäne, zu der sie gehören, in "Bereiche" aufzuteilen, oder ist es besser, ein einzelnes Modell beizubehalten? Beispielsweise gibt es die Unterdomänen "Vertrieb" und "Inventar". Benutzer des Systems kümmern sich normalerweise jeweils nur um …
2
Entwerfen einer API mit Zugriffstoken, Wie werden GET-Anforderungen behandelt?
Ich erstelle eine API, die Zugriffstoken verwendet, damit ich die Nutzung zwischen verschiedenen Abteilungen und für die Zugriffskontrolle verfolgen kann. Mein Plan ist es, die HTTP-Verben angemessen zu verwenden - GETInformationen abzurufen, POSThinzuzufügen, zu DELETElöschen usw. Meine Frage ist, wie ich mit Zugriffstoken bei den GET-Aufrufen umgehen soll. Option eins: …
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.