2017-08-31 4 views
2

Gibt es einen Namen für ein Stück einer API?Was ist eine Komponente einer REST-API, die aufgerufen wird?

Zum Beispiel sagen, ich habe eine API die vier Dienste bietet:

getCustomerInfo 
setCustomerInfo 
getProductInfo 
setProductInfo 

Dann sagen, ich möchte ein Kollege sagen:

Die API eine fünfte Webhook brauchen wird?

Ich weiß, das ist eine falsche Verwendung des Wortes Webhook.

Wie lautet die korrekte Terminologie? Danke!

UPDATE: Dies könnte ein Duplikat sein. krishna kanth Antwort hier: What is an Endpoint? ist:

Der Begriff Endpoint zunächst für WCF-Dienste verwendet wurde. Später sogar obwohl dieses Wort auch für API-Ressourcen verwendet wird, empfiehlt REST , diese URI (URI [s], die HTTP-Verben verstehen und folgen REST-Architektur) als "Ressource".

Kurz gesagt, eine Ressource oder Endpunkt ist eine Art von Einstiegspunkt zu einer Remote-Hosted-Anwendung, die die Benutzer über das HTTP-Protokoll zu ihm kommunizieren können.

Antwort

4

Ich denke, das Wort, das Sie suchen, ist Ressource. Ich denke auch, dass das Abrufen und Setzen unter einer einzigen Ressource kombiniert werden würde und die HTTP-Aufrufe an diese Ressource definieren würden, ob Sie GET oder PUTing verwenden (Einstellung in REST über HTTP).

2

Ich denke im Allgemeinen eine API ist eine Reihe von Methoden der Kommunikation zwischen verschiedenen Softwarekomponenten.

Also würde ich sagen: Die API wird eine fünfte Methode benötigen?

Wikipedia definiert auch API und Methoden hier: https://en.wikipedia.org/wiki/Application_programming_interface

+0

Ausgehend von einem WebAPI-Hintergrund mag ich auch "Methode". Ich neige dazu, meine REST-APIs in Substantive (Gruppenkonzept; Controller) und Verben (Methoden von Substantiven/Controllern) zu gruppieren. –

1

Roy Thomas Fieldings definiert sie als Resource Identifier in Ihrer Dissertation für den Grad eines Doktors der Philosophie (siehe Architectural Styles and the Design of Network-based Software Architectures).

Nach Roy Fielding:

REST eine resource identifier verwendet die bestimmte Ressource in einer Wechselwirkung zwischen beteiligten Komponenten zu identifizieren.

Ich glaube, Sie die Ressource Identifier /product Sie behandeln die product Ressource und die Ressourcenkennung der customer Ressource /customer verwenden können, zu behandeln. Verwenden Sie auch die entsprechende HTTP-Methode, um die gewünschte Aktion auszuführen.Zum Beispiel:

  • PUT /product/{id} eine product Ressource durch {id} (anstelle von setProductInfo)
  • GET zu /product/{id} zurückzukehren, um eine Darstellung einer product Ressource durch {id} (statt getProductInfo)
identifiziert identifiziert zu bearbeiten
Verwandte Themen