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.

6
Gibt es ein Muster für den Umgang mit widersprüchlichen Funktionsparametern?
Wir haben eine API-Funktion, die einen Gesamtbetrag basierend auf den angegebenen Start- und Enddaten in monatliche Beträge aufteilt. // JavaScript function convertToMonths(timePeriod) { // ... returns the given time period converted to months } function getPaymentBreakdown(total, startDate, endDate) { const numMonths = convertToMonths(endDate - startDate); return { numMonths, monthlyPayment: total …
38 api-design 
5
Wie kann man eine Architekturverschiebung beschreiben, die absichtlich REST-Standards verletzt?
Ich schlage Änderungen an einem sehr schlecht strukturierten Softwareprojekt vor, das unter einer Vielzahl von Problemen leidet. Auf hohem Niveau nutzt das Projekt Angular im Front-End und verwendet verschiedene REST-APIs. Das ist alles großartig (ich sehe keine Notwendigkeit, unsere Technologie oder Werkzeuge zu ändern). Das Problem ist, dass die Codebasis …
3
REST-API - Soll die API geschachtelte JSON-Objekte zurückgeben?
Wenn es um JSON-APIs geht, ist es empfehlenswert, Antworten zu reduzieren und verschachtelte JSON-Objekte zu vermeiden? Nehmen wir als Beispiel an, wir haben eine ähnliche API wie IMDb, jedoch für Videospiele. Es gibt ein paar Entitäten, Game, Platform, ESRBRating und GamePlatformMap, die Spiele und Plattformen zuordnen. Nehmen wir an, Sie …
37 design  rest  api-design  json 
6
Sollte eine HTTP-API immer einen Body zurückgeben?
Gibt es einen Standard für HTTP-API-Antworten? Nachdem ich diesen Diskussionsfaden gelesen hatte, begann ich mich zu wundern. Wir entwickeln unsere öffentliche HTTP-JSON-API in meiner Arbeit und geben nichts zurück, wenn es nicht unbedingt benötigt wird (z. B. ein PUT an / resource / {id} gibt nur 200 zurück, wenn OK …
33 rest  api-design  http 
4
Sollten Microservices miteinander sprechen?
Ich entwerfe eine Anwendung unter Verwendung von Micro-Services und bin mir nicht sicher, welchen Mechanismus ich am besten verwenden kann, um Daten von mehreren Services zu sammeln. Ich glaube, es gibt zwei Möglichkeiten: Integrieren Sie einen Kommunikationsmechanismus zwischen den Diensten, mit dem die Dienste direkt kommunizieren können. Das API-Gateway ruft …
7
Warum ein undurchsichtiges „Handle“ verwenden, für das ein Casting in einer öffentlichen API anstelle eines typsicheren Strukturzeigers erforderlich ist?
Ich bewerte eine Bibliothek, deren öffentliche API derzeit so aussieht: libengine.h /* Handle, used for all APIs */ typedef size_t enh; /* Create new engine instance; result returned in handle */ int en_open(int mode, enh *handle); /* Start an engine */ int en_start(enh handle); /* Add a new hook to …
4
Microservices und Datenspeicherung
Ich überlege, eine monolithische REST-API auf eine Microservice-Architektur umzustellen, und bin etwas verwirrt über die Datenspeicherung. Aus meiner Sicht wären einige der Vorteile von Microservices: Horizontal skalierbar - Ich kann mehrere redundante Kopien eines Mikrodienstes ausführen, um die Last und / oder den Ausfall eines Servers zu bewältigen. Locker gekoppelt …
3
RESTful API: HTTP-Verben mit gemeinsamen oder bestimmten URLs?
Soll ich beim Erstellen einer RESTful-API HTTP-Verben unter derselben URL verwenden (sofern dies möglich ist) oder eine bestimmte URL pro Aktion erstellen? Beispielsweise: GET /items # Read all items GET /items/:id # Read one item POST /items # Create a new item PUT /items/:id # Update one item DELETE /items/:id …
10
API-Design: Konkreter vs. abstrakter Ansatz - Best Practices?
Bei der Erörterung von APIs zwischen Systemen (auf Unternehmensebene) gibt es in unserem Team häufig zwei unterschiedliche Standpunkte: Einige bevorzugen einen allgemeineren abstrakten Ansatz, andere einen direkten "konkreten" Ansatz. Beispiel: Entwurf einer einfachen API für die Personensuche. die konkrete version wäre searchPerson(String name, boolean soundEx, String firstName, boolean soundEx, String …
3
Ist es in Ordnung, HTML von einer JSON-API zurückzugeben?
In meinem aktuellen Projekt bin ich für die Implementierung eines Dienstes verantwortlich, bei dem neu erstellte RESTful-APIs verwendet werden, von denen dokumentiert ist, dass sie ausschließlich JSON unterstützen. Der Client stellt konsistent Anforderungen mit dem Accept-Header "application / json" und dem Inhaltstyp "application / json". Einige Endpunkte senden jedoch eine …
4
Soll ich beim Erstellen einer API bei kleinen Funktionen und vielen Aufrufen bleiben oder bei einigen Aufrufen und großen Funktionen?
Ich habe eine Schienenplattform, die ich pflege. Darauf sind viele verschiedene Webanwendungen aufgebaut. Jetzt fordert ein Client jedoch eine API an, damit die Benutzer auf ihrer Website bleiben, aber einige der automatisierten Aufgaben nutzen können, die wir haben. Die Plattform wird zum Erstellen von Versicherungsanwendungen verwendet und ermöglicht deren Online-Kauf …
3
Empfohlener HTTP-Statuscode für die Antwort "Planlimit überschritten"
Ich entwerfe eine REST-API für ein Projekt, in dem Benutzer immer einen von mehreren "Plänen" verwenden. Jeder Plan definiert einige Ressourcenbegrenzungen, z. B. die maximale Anzahl von Benutzern, die ein Konto haben darf, oder die maximale Anzahl von Daten, die sie hochladen dürfen. Sobald eines dieser Limits erreicht ist, können …
24 rest  api-design  http 
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.