Softwareentwicklung api

5

Wann wird eine API als eingebettetes DSL betrachtet?

Was ist der Unterschied zwischen einer API und einer eingebetteten domänenspezifischen Sprache (DSL)? Ist es nur Syntax? Betrachten Sie eine API wie OpenGL. Wie unterscheidet sich das von einem Grafik-DSL? Mit anderen Worten, wenn eine API ausreichend komplex ist, kann sie als eingebettetes DSL betrachtet werden?

10 api dsl

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 …

9 rest api domain-driven-design api-design single-responsibility

2

Hinzufügen zu einer endlichen Reihe von Optionen; eine API brechen Änderung?

Nehmen Sie einen HTTP-API-Endpunkt, der das folgende Antwortmodell ausspuckt: { "type": "Dog", "name": "Jessi", ... } Das typeFeld wurde als eine der in der Dokumentation beschrieben Dog, Catoder Fish. Würde das Hinzufügen einer neuen Option Ratbeispielsweise als brechende API-Änderung angesehen? Wird das Hinzufügen einer Option zu einer endlichen Liste (die …

9 rest api api-design json

3

Was ist im REST-Sprachgebrauch der Unterschied zwischen einer Ressource und einer Darstellung?

Mein Verständnis von REST ermöglicht das Modellieren von Serviceoperationen als Darstellung des Status und Übergang von einem Status zu einem anderen unter Verwendung von HTTP. Ich habe Ressourcen bis vor kurzem immer als Repräsentationen des Service-Side-State verstanden, als ich diesen Artikel von Jimmy Bogard las, von dem ich weiß, dass …

9 rest api api-design

2

Warnungen in einer REST-API als nicht kritische Fehler

Ich habe eine REST-API, die für einige Entpoinds wie DELETE, POST oder PUT einige Validierungsregeln enthält, die einen Fehler zurückgeben können. Jetzt brauche ich einen neuen Fehlertyp wie einen unkritischen Fehler, der auf normale Weise fehlschlagen sollte, aber die Aktion ausführen sollte, wenn die Flags "Warnungen unterdrücken" gesendet werden. Ein …

9 rest api

3

CRUD-API: Wie geben Sie an, welche Felder aktualisiert werden sollen?

Angenommen, Sie haben eine Art Datenstruktur, die in einer Art Datenbank beibehalten wird. Nennen wir diese Datenstruktur der Einfachheit halber Person. Sie müssen nun eine CRUD-API entwerfen, mit der andere Anwendungen Persons erstellen, lesen, aktualisieren und löschen können . Nehmen wir zur Vereinfachung an, dass auf diese API über eine …

9 design api web-services api-design crud

3

verwendet einen PUT mit akzeptablen Nebenwirkungen (REST)

Ich möchte einen Rückgängig-Verlauf erstellen, wenn der Benutzer ein Formular aktualisiert. Da es sich um ein Update handelt, möchte ich eine PUT-Anforderung verwenden. Ich habe jedoch gelesen, dass PUT keine Nebenwirkungen haben muss . Ist es akzeptabel, hier PUT zu verwenden? Gibt es bessere Alternativen? PUT /person/F02E395A235 { time: 1234567, …

9 language-agnostic api rest

4

Ist es eine gute Praxis, eine API-Antwortliste mit Werten als Wörterbuch zu erstellen?

Ich habe einen API-Endpunkt, der einige Statistiken zurückgibt. Derzeit sieht die Antwort so aus: Option 1: { "stats": [ { "name": "some-stats-key1", "value": 10 }, { "name": "some-stats-key2", "value": 20 } ], ... other keys } Aber das sieht ein bisschen komplex aus und ich weiß, wie ich es machen …

9 rest api json

3

REST-API im Vergleich zu direkten DB-Aufrufen in der Desktop-Anwendung

Ich plane derzeit eine Anwendung, die in einem Unternehmen verwendet wird. Es ist erforderlich, eine Desktop-Anwendung zu erstellen. Derzeit sind sie sich nicht sicher, ob die Anwendung in naher Zukunft auf Mobilgeräten oder im Browser verfügbar sein soll. Ich habe zwei Möglichkeiten: Greifen Sie direkt über die Desktop-Anwendung auf die …

9 architecture rest api desktop-application

5

Konsequenzen, wenn eine REST-API nicht „richtig“ ausgeführt wird?

Ich werde diese Frage auf diese Weise stellen - was sind die Bedenken der Softwareentwicklung, wenn meine REST-API nicht "richtig" implementiert wird? Was meinst du mit dem "richtigen" Weg? Lassen Sie mich meine Wahrnehmung des richtigen Weges erklären, dann erkläre ich Ihnen, wie ich es mache (nehmen Sie auch an, …

8 design rest api standards

2

Behandeln von Fehlermeldungen von anderen Diensten in Micro Service Architecture

Unser Unternehmen führt Anwendungen auf einer Micro Service-Architektur aus, die Tausende von Diensten umfasst. Ich arbeite an einer Backend-Anwendung "X", die mit mehr als 50 Diensten kommuniziert. Frontend-Dienste rufen meinen Dienst "X" auf, um Anforderungen für andere Dienste auszuführen. Problem : Das Front-End möchte benutzerfreundliche Nachrichten anzeigen, wenn bei anderen …

8 api microservices error-handling

2

Kann ein Anrufer eine Ausführung von Code abbrechen, der durch eine HTTP-Anforderung aufgerufen wird?

Ein Dritter, der HTTP-Anforderungen an die von mir erstellte API stellt, muss in weniger als einer Sekunde antworten. Meine Frage ist, haben sie einen Weg (buchstäblich jede Art und Weise, innerhalb der Grenzen des HTTP und / oder TCP / IP - Protokolle) , um die Ausführung meines Codes abzubrechen …

8 c# api asp.net http asp.net-core

1

Token-basierte Authentifizierung mithilfe von Zugriffs- und Aktualisierungstoken

Ich implementiere ein tokenbasiertes Authentifizierungssystem für eine REST-API unter Verwendung eines kurzlebigen Zugriffstokens und eines langlebigen Aktualisierungstokens. Dies ist eine abstrakte Übersicht über die relevanten API-Endpunkte (HTTPS wird für alle Endpunkte erzwungen): Endpunkte: POST /register/ POST /login/ POST /logout/ POST /password/change/ Implementierung: POST /register/:: Anfrage: Der Client sendet Benutzernamen, E-Mail …

8 design rest api security authentication

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

5

Wie kann verhindert werden, dass Änderungen an einer internen API andere Projekte beschädigen?

Wir haben 20 - 30 unabhängige Module / Lösungen. Jedes von diesen hat ungefähr 7 - 10 Projekte mit verschiedenen Klassen, Komponenten usw. Diese werden alle unternehmensintern verwendet. Unser Problem ist, wenn wir eine Änderung in einem Modul vornehmen, müssen wir sicherstellen, dass alle anderen Module aktualisiert werden, die auf …

8 documentation api configuration-management change-management

Als «api» getaggte Fragen