search

FabLabSiegen / accesslog

Access Control and Management System for a Fab Lab
1 stars 1 forks source link

Informationsabruf zu einem spezifischen 3D-Modell per REST API bereitstellen #18

Closed FlorianJa closed 2 years ago

FlorianJa commented 3 years ago

Über diese Schnittstelle sollen Informationen zu einem spezifischen 3D Modell abgerufen werden.

Die Route soll hostname/api/models/MODELNAME lauten

Für das Abrufen soll die http Get Methode verwendet werden.

Der Nutzer muss sich bei dem System authentifizieren damit sichergestellt werden kann, ob der Nutzer diese Informationen abrufen darf. Dies kann beispielsweise über einen API-Key erfolgen, der im Header mitgeschickt wird. Wenn die Authentifizierung nicht klappt, dann soll ein http 401 zurückgegeben werden

Die Antwort erfolgt im JSON Format

Die Antwort beinhaltet Metainformationen zu dem Modell wie zum Beispiel:

FelixDango commented 2 years ago

Soll bei "Name" der Dateiname also mit Endung bspw. .stl oder .obj gespeichert werden oder ein selbstgewählter neuer Name? @FlorianJa

FlorianJa commented 2 years ago

Name ist der vollständige Dateiname, also mit Dateiendung.

FlorianJa commented 2 years ago

EDIT: ich war mit meinen Gedanken wo anders. Für die API muss der vollständige Name angegeben werden.

Für die Suche wäre es aber bestimmt sinnvoll, wenn ohne Dateiendung gesucht werden kann.

FlorianJa commented 2 years ago

Die Suche ist aber erstmal nicht so wichtig, da das System hauptsächlich durch andere Anwendungen angesprochen wird und dort in der Regel mit den IDs gearbeitet wird (deshalb soll bspw. auch die ID zurückgegeben werden wenn ein Modell hochgeladen wird)

FlorianJa commented 2 years ago

Zusätzlich bitte die gleiche Funktion nochmal implementieren, bei der die ID statt dem MODELLNAMEN übergeben wird. Die Rückgabe soll die selbe sein.

also: hostname/api/models/ID